react-auto-bind

Automatically bind methods to their class instance. This is optimized for react. It doesn't bind render and other lifecycle methods.

Install

$ npm install --save react-auto-bind

Usage

1const autoBind = require('react-auto-bind');
2
3class Unicorn {
4	constructor(name) {
5		this.name = name;
6		autoBind(this);
7	}
8	message() {
9		return `${this.name} is awesome!`;
10	}
11}
12
13const unicorn = new Unicorn('Rainbow');
14
15// Grab the method off the class instance
16const message = unicorn.message;
17
18// Still bound to the class instance
19message();
20//=> 'Rainbow is awesome!'
21
22// While message() would not be bound & would have resulted in
23message();
24//=> Error: Cannot read property 'name' of undefined

Bind only some methods

1const autoBind = require('react-auto-bind');
2
3class Griffin {
4	constructor(name) {
5		this.name = name;
6		autoBind(this, 'amaze');
7	}
8	amaze() {
9		return `${this.name} is amazing!`;
10	}
11	message() {
12		return `${this.name} is undefined!`;
13	}
14}
15
16const buckbeak = new Griffin('Buckbeak');
17
18// Grab the method off the class instance
19const message = buckbeak.message;
20const amaze = buckbeak.amaze;
21
22// Still bound to the class instance
23amaze();
24//=> 'Buckbeak is amazing!'
25
26// Without `autoBind(this)`, the above would have resulted in
27message();
28//=> Error: Cannot read property 'name' of undefined

API

autoBind(self, [...bindOnly])

Bind methods in self to their class instance. Returns the self object.

self

Type: Object

Object with methods to bind.

bindOnly

Type: Strings

If more than one parameters are passed then only those methods are bound.

Related

• bind-methods - Bind all methods in an object to itself or a specified context
• auto-bind - Automatically bind all methods to their class instance.