wallet-core/node_modules/auto-bind/readme.md

96 lines
1.6 KiB
Markdown
Raw Normal View History

2017-05-28 00:38:50 +02:00
# auto-bind [![Build Status](https://travis-ci.org/sindresorhus/auto-bind.svg?branch=master)](https://travis-ci.org/sindresorhus/auto-bind)
> Automatically bind methods to their class instance
## Install
```
2018-09-20 02:56:13 +02:00
$ npm install auto-bind
2017-05-28 00:38:50 +02:00
```
## Usage
```js
const autoBind = require('auto-bind');
class Unicorn {
constructor(name) {
this.name = name;
autoBind(this);
}
2018-09-20 02:56:13 +02:00
2017-05-28 00:38:50 +02:00
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
2018-09-20 02:56:13 +02:00
### autoBind(self, [options])
2017-05-28 00:38:50 +02:00
Bind methods in `self` to their class instance. Returns the `self` object.
#### self
Type: `Object`
Object with methods to bind.
2018-09-20 02:56:13 +02:00
#### 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);
}
// …
}
```
2017-05-28 00:38:50 +02:00
## 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)