Wrap a function without changing its name and other properties.
Function wrappers return a new function which means the original function's
name
and other properties are usually lost. This module enhances them to keep
those properties instead.
The new function will also print the original function's body when stringified.
Function wrappers are commonly used in functional programming. They take a function as input and return it wrapped. Examples include memoizing or ensuring a function is only called once.
const keepFuncProps = require('keep-func-props')
// Any function wrapper works
const memoize = require('lodash/memoize')
const betterMemoize = keepFuncProps(memoize)
const anyFunction = () => true
// Function `name` and other properties are kept
console.log(anyFunction) // `[Function: anyFunction]`
console.log(memoize(anyFunction)) // `[Function: memoized]`
console.log(betterMemoize(anyFunction)) // `[Function: anyFunction]`
// Function body is kept when stringified
console.log(String(anyFunction))
// () => true
console.log(String(memoize(anyFunction)))
// function() {
// var args = arguments,
// key = resolver ? resolver.apply(this, args) : args[0],
// cache = memoized.cache;
// ...
// }
console.log(String(betterMemoize(anyFunction)))
// /* Wrapped with memoized() */
// () => true
You can try this library:
- either directly in your browser.
- or by executing the
examples
files in a terminal.
npm install keep-func-props
const keepFuncProps = require('keep-func-props')
// Any function wrapper works
const wrapper = function(anyFunction) {
return (...args) => anyFunction(...args)
}
// `betterWrapper` is like `wrapper` but it keeps the function properties
const betterWrapper = keepFuncProps(wrapper)
wrapper
: (anyFunction, [...args]) => newFunction
Returns: new wrapper
A function wrapper
is passed as argument. A copy of it is returned.
mimic-fn
: same but for functions that do not wrap other functions.
If you found a bug or would like a new feature, don't hesitate to submit an issue on GitHub.
For other questions, feel free to chat with us on Gitter.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
This project was made with โค๏ธ. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
ehmicky ๐ป ๐จ ๐ค ๐ |