mimic-fn
Advanced tools
Package description
The mimic-fn package is a utility that allows you to copy the properties of a function onto another function. This includes the function's name, length (the number of arguments it expects), and custom properties. It is useful when you want to wrap a function without losing its original properties, which can be important for debugging, introspection, and certain function-based APIs that rely on these properties.
Copying function properties
This feature allows you to copy all properties from the original function to the wrapper function, including the function name and custom properties.
const mimicFn = require('mimic-fn');
function original() {}
original.customProp = 'hello';
function wrapper() {
return original();
}
console.log(wrapper.name); // 'wrapper'
console.log(wrapper.customProp); // undefined
mimicFn(wrapper, original);
console.log(wrapper.name); // 'original'
console.log(wrapper.customProp); // 'hello'The function-copy package is similar to mimic-fn in that it copies properties from one function to another. However, it may not be as up-to-date or widely used as mimic-fn.
The rename-function package allows you to change the name of a function, which is one aspect of what mimic-fn does. However, it does not handle copying other properties or the function's length.
Readme
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.
$ npm install mimic-fn
import mimicFunction from 'mimic-fn';
function foo() {}
foo.unicorn = '🦄';
function wrapper() {
return foo();
}
console.log(wrapper.name);
//=> 'wrapper'
mimicFunction(wrapper, foo);
console.log(wrapper.name);
//=> 'foo'
console.log(wrapper.unicorn);
//=> '🦄'
console.log(String(wrapper));
//=> '/* Wrapped with wrapper() */\nfunction foo() {}'
Modifies the to function to mimic the from function. Returns the to function.
name, displayName, and any other properties of from are copied. The length property is not copied. Prototype, class, and inherited properties are copied.
to.toString() will return the same as from.toString() but prepended with a Wrapped with to() comment.
Type: Function
Mimicking function.
Type: Function
Function to mimic.
Type: object
Type: boolean
Default: false
Skip modifying non-configurable properties instead of throwing an error.
FAQs
Make a function mimic another one
The npm package mimic-fn receives a total of 49,601,405 weekly downloads. As such, mimic-fn popularity was classified as popular.
We found that mimic-fn demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.