Blame view

node_modules/mimic-fn/readme.md 1.03 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
  # mimic-fn [![Build Status](https://travis-ci.org/sindresorhus/mimic-fn.svg?branch=master)](https://travis-ci.org/sindresorhus/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
  
  ```js
  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](https://github.com/sindresorhus/rename-fn) - Rename a function
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)