node_modules/mimic-fn/readme.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

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)

It will modify to and return it.

to

Type: Function

Mimicking function.

from

Type: Function

Function to mimic.

Related

• rename-fn - Rename a function

License

MIT © Sindre Sorhus

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.