Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/keep-func-props
Wrap a function without changing its name and other properties
https://github.com/ehmicky/keep-func-props
call es6 function functional functional-programming functor javascript length library mimic name nodejs properties typescript wrapper
Last synced: 6 days ago
JSON representation
Wrap a function without changing its name and other properties
- Host: GitHub
- URL: https://github.com/ehmicky/keep-func-props
- Owner: ehmicky
- License: mit
- Created: 2019-02-26T20:53:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T23:11:58.000Z (2 months ago)
- Last Synced: 2024-10-27T22:17:41.510Z (19 days ago)
- Topics: call, es6, function, functional, functional-programming, functor, javascript, length, library, mimic, name, nodejs, properties, typescript, wrapper
- Language: JavaScript
- Homepage:
- Size: 8.96 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/keep-func-props)
[](https://unpkg.com/keep-func-props?module)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/keep-func-props)
[](https://bundlephobia.com/package/keep-func-props)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
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](https://github.com/planttheidea/moize) or ensuring a function is
only called once.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Example
```js
import keepFuncProps from 'keep-func-props'
// Any function wrapper works
import memoize from 'lodash/memoize.js'
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
```
# Install
```bash
npm install keep-func-props
```
This package works in both Node.js >=18.18.0 and
[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# Usage
```js
import keepFuncProps from 'keep-func-props'
// Any function wrapper works
const wrapper =
(anyFunction) =>
(...args) =>
anyFunction(...args)
// `betterWrapper` is like `wrapper` but it keeps the function properties
const betterWrapper = keepFuncProps(wrapper)
```
## keepFuncProps(wrapper)
`wrapper`: `(anyFunction, [...args]) => newFunction`\
_Returns_: new `wrapper`
A function `wrapper` is passed as argument. A copy of it is returned.
# See also
- [`mimic-function`](https://github.com/sindresorhus/mimic-function): same but
for functions that do not wrap other functions.
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
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](CONTRIBUTING.md). Pull requests are welcome!