blob: a40bcc43aaded4d0299b81486181773538c86e6d (
plain)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# auto-bind [](https://travis-ci.org/sindresorhus/auto-bind)
> Automatically bind methods to their class instance
## Install
```
$ npm install auto-bind
```
## Usage
```js
const autoBind = require('auto-bind');
class Unicorn {
constructor(name) {
this.name = name;
autoBind(this);
}
message() {
return `${this.name} is awesome!`;
}
}
const unicorn = new Unicorn('Rainbow');
// Grab the method off the class instance
const message = unicorn.message;
// Still bound to the class instance
message();
//=> 'Rainbow is awesome!'
// Without `autoBind(this)`, the above would have resulted in
message();
//=> Error: Cannot read property 'name' of undefined
```
## API
### autoBind(self, [options])
Bind methods in `self` to their class instance. Returns the `self` object.
#### self
Type: `Object`
Object with methods to bind.
#### options
Type: `Object`
##### include
Type: `Array<string|RegExp>`
Bind only the given methods.
##### exclude
Type: `Array<string|RegExp>`
Bind methods except for the given methods.
### autoBind.react(self, [options])
Same as `autoBind`, but excludes the default [React component methods](https://reactjs.org/docs/react-component.html).
```js
class Foo extends React.Component {
constructor(props) {
super(props);
autoBind.react(this);
}
// …
}
```
## Related
- [bind-methods](https://github.com/sindresorhus/bind-methods) - Bind all methods in an object to itself or a specified context
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
