5.0.1 • Published 4 years ago

auto-bind v5.0.1

Weekly downloads
1,039,085
License
MIT
Repository
github
Last release
4 years ago

auto-bind

Automatically bind methods to their class instance

It also correctly binds inherited properties.

Install

npm install auto-bind

Usage

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<string | RegExp>

Bind only the given methods.

exclude

Type: Array<string | RegExp>

Bind methods except for the given methods.

React

Same as autoBind but excludes the default React component methods.

import autoBindReact from 'auto-bind/react';

class Foo extends React.Component {
	constructor(props) {
		super(props);
		autoBindReact(this);
	}

	// …
}

Related

  • bind-methods - Bind all methods in an object to itself or a specified context
sonos-radio-salietchelon-gql-typescript-apollo-angular@stelladoradus/hermes-cli@stelladoradus/stella-cli@ourharvest/email-templates@xornot/boundnocodb1rc-crudweb-hook-test-lambda@prodam/prodam-types@lightsparkdev/js-sdknocodb-daily@everything-registry/sub-chunk-1184@imtbl/imxd-clientimx-sdk@slide-web3/sdktangerinetapstrapteraslice-client-jssveltify-vitewirewithhold-message-avaxc-typeormxc-core-tsxc-data-mapperxc-data-mapper-tsxc-instantxgenetelegram-bot-makertemba-analyticssstackoverflow-clithree-voxel-loadervoicer@domassistant/gateway-js@dotconf-pro/dotconf-pro@dotconf-pro/dotenv@dplewis/react-material-ui-5-carousel@coasys/ad4m-connect@codelab-app/gql-tag-operations@croia/post-messenger@concorde2k/ccconfig@custis/common@custis/front-scripts@cyberhck/typescript-graphql-apollo-temp@d10d/common@dinhthaimanh/typescript-react-query@bluecadet/launchpad@bluecadet/launchpad-cli@bluecadet/launchpad-monitor@bluecadet/launchpad-utils@perspect3vism/ad4m-connect@runcapsule/graphql-codegen-typescript-react-apollobetter-frames-1jimmifyjpeg-camera-es6jspsychjerry-generic-sdkjerry-react-apollojointedisoflowkudagridsome-make@concorde2k/ccsqlstrict-async-storagesum-component-36typescript-generic-sdktypescript-graphql-requesttypescript-graphql-request-with-retriestypescript-solid-querytypescript-fixturestypescript-vue-urql-remasteredtorusgo-logictimegrifyts-codegen-plugin@apollo-orbit/codegen@anima-help/webeye-tracking@anglinb/graphql-codegen-apollo-next-ssr@atmina/local-typescript-operations@atmina/only-enum-types@asiz33/smartblok-vendure-plugin@alleycorpnord/state@baeta/ink@baeta/plugin-graphql@babyshop/typescript@babyshop/visitor-plugin-common@beegru/react-material-ui-carousel@azondo/api@azondo/api-old@aggelia/client@aggelia/client-js@bigtest/ink@bridges-wood/graphql-codegen-nestjs@cardstack/hub@bravo68web/utils@capevace/mission-control@cdn-publishing/graphql-codegen-c-sharp-common@chrissung/the-one-sdk-node@chromatic-protocol/typescript-graphql-request@charlieduong94/graphql-codegen-typescript-apollo-client@abramltd/jwt-oauth2-middleware
5.0.1

4 years ago

5.0.0

4 years ago

4.0.0

5 years ago

3.0.0

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago

2.0.0

6 years ago

1.2.1

7 years ago

1.2.0

7 years ago

1.1.0

8 years ago

1.0.0

8 years ago

0.1.0

9 years ago