https://github.com/sindresorhus/auto-bind

Automatically bind methods to their class instance
https://github.com/sindresorhus/auto-bind

Last synced: 7 days ago
JSON representation

Automatically bind methods to their class instance

• Host: GitHub
• URL: https://github.com/sindresorhus/auto-bind
• Owner: sindresorhus
• License: mit
• Created: 2016-08-09T19:38:20.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2022-07-08T00:50:06.000Z (over 2 years ago)
• Last Synced: 2025-01-08T22:06:50.488Z (23 days ago)
• Language: JavaScript
• Size: 29.3 KB
• Stars: 459
• Watchers: 6
• Forks: 34
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-repositories - sindresorhus/auto-bind - Automatically bind methods to their class instance (JavaScript)

README

        
# auto-bind

> Automatically bind methods to their class instance

It also correctly binds inherited properties.

If you're targeting Node.js 12 and later or the browser, you should consider using [class fields](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Public_class_fields#public_instance_fields) instead.

## Install

```sh

npm install auto-bind

```

## Usage

```js

import autoBind from '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`

An object with methods to bind.

#### options

Type: `object`

##### include

Type: `Array`

Bind only the given methods.

##### exclude

Type: `Array`

Bind methods except for the given methods.

### React

Same as `autoBind` but excludes the default [React component methods](https://reactjs.org/docs/react-component.html).

```js

import autoBindReact from 'auto-bind/react';

class Foo extends React.Component {

	constructor(props) {

		super(props);

		autoBindReact(this);

	}

	// …

}

```

## Related

- [bind-methods](https://github.com/sindresorhus/bind-methods) - Bind all methods in an object to itself or a specified context