Ts-class-autobind NPM

Method auto-bind for TypeScript

GitHub top language GitHub code size in bytes GitHub last commit Snyk Vulnerabilities for GitHub Repo

This package provides a single function, autobind, for use within a constructor to bind all methods to the instance itself.

For example, this allows us to pass a method to an event handler element.addEventListener('click', this.onClick) and be sure the onClick method will always be called with the right context.

Note: This has some specific logic for React, but could be used in any project.

Requirements

TypeScript 3.0 or higher

Installation:

npm install --save ts-class-autobind

Usage:

import { autobind } from "ts-class-autobind";

class MyComponent extends React.Component {
    constructor() {
        super(...arguments);
        autobind(this);
    }
    render() {
        return <button onClick={this.onClick}>Click Me</button>;
    }
    onClick() {
        console.log("Button Clicked");
    }
}

Advanced Usage:

If your component will possibly be subclassed (you really should not do this, but some third-party libraries like react-css-modules do so) then you will need to specify which prototype will be the source of methods that are to be automatically bound.

import { autobind } from "ts-class-autobind";

class MyComponent extends React.Component {
    constructor() {
        super(...arguments);
        autobind(this, MyComponent.prototype); // Note the second parameter.
    }
    render() {
        /* ... */
    }
}

class MySubClassedComponent extends MyComponent {
    /* This is probably a very bad idea. */
}