# mimic-function

> Make a function mimic another one

Latest version **5.0.1** (published 2024-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install mimic-function
pnpm add mimic-function
yarn add mimic-function
bun add mimic-function
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2024-03-14 |
| First published | 2023-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 96 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | function, mimic, imitate, rename, copy, inherit, properties, name, func, fn, set, infer, change |

## Links

- npm: https://www.npmjs.com/package/mimic-function
- Repository: https://github.com/sindresorhus/mimic-function
- Homepage: https://github.com/sindresorhus/mimic-function#readme
- Issues: https://github.com/sindresorhus/mimic-function/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/mimic-function

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 5.0.1 (latest) — 2024-03-14
- 5.0.0 — 2023-11-05

## README

<picture>
	<source media="(prefers-color-scheme: dark)" srcset="media/logo_dark.svg">
	<img alt="mimic-function logo" src="media/logo.svg" width="400">
</picture>
<br>

> Make a function mimic another one

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

## Install

```sh
npm install mimic-function
```

## Usage

```js
import mimicFunction from 'mimic-function';

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() {}'
```

## API

### mimicFunction(to, from, options?)

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.

#### to

Type: `Function`

Mimicking function.

#### from

Type: `Function`

Function to mimic.

#### options

Type: `object`

##### ignoreNonConfigurable

Type: `boolean`\
Default: `false`

Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.

## Related

- [rename-fn](https://github.com/sindresorhus/rename-fn) - Rename a function
- [keep-func-props](https://github.com/ehmicky/keep-func-props) - Wrap a function without changing its name and other properties

---
_Source: https://npm.io/package/mimic-function · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._