History

Nat 96939b7aee Clean up repo and update deps		2024-03-10 11:52:04 -07:00
..
index.d.ts	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
index.js	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
license	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
package.json	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
readme.md	Clean up repo and update deps	2024-03-10 11:52:04 -07:00

readme.md

mimic-fn

Make a function mimic another one

Useful when you wrap a function in another function and like to preserve the original name and other properties.

Install

$ npm install mimic-fn

Usage

const mimicFn = require('mimic-fn');

function foo() {}
foo.unicorn = '🦄';

function wrapper() {
	return foo();
}

console.log(wrapper.name);
//=> 'wrapper'

mimicFn(wrapper, foo);

console.log(wrapper.name);
//=> 'foo'

console.log(wrapper.unicorn);
//=> '🦄'

API

It will copy over the properties name, length, displayName, and any custom properties you may have set.

mimicFn(to, from)

Modifies the to function and returns it.

to

Type: Function

Mimicking function.

from