ES7 Autobinder

ES7 Autobinder allows you to declaratively and automatically bind methods on ES6 classes to this when called. It uses ES7 decorators to annotate class methods, and so requires an environment supporting classes and decorators. The Babel project with stage 1 experimental features enabled can provide this.

Installation

npm install [--save] es7-autobinder

API

• require("es7-autobinder").autobound

A decorator used to mark a method as autobound.

class MyClass {
  @autobound
  myMethod() {
    // ...
  }
}

Examples

Say you have a class with a method you always want to be bound to the instance of the class.

class Clicker {
  constructor(selector) {
    this.onClickText = "clicked!";
    $(selector).click(this.handleClick);
  }

  handleClick() {
    console.log(this.onClickText);
  }
}

const instance = new Clicker(".element");

Since handleClick is called from a jQuery event handler, this is the element that was clicked, and not the Clicker instance. You can fix this manually by either binding to the target when referring to the method:

$(selector).click(this.handleClick.bind(this));

or by manually binding the method to the instance:

this.handleClick = this.handleClick.bind(this);
$(selector).click(this.handleClick);

However, when there are many methods on the class you need to bind in this fashion, it's easy to forget, or to mistakenly create many such bound functions (such as in a React render method).

ES7 Autobinder allows you to use decorators to declaratively specify methods that should be automatically bound to the instance.

const { autobound } = require("es7-autobinder");

class Clicker {
  constructor(selector) {
    this.onClickText = "clicked!";
    $(selector).click(this.handleClick);
  }

  @autobound
  handleClick() {
    console.log(this.onClickText);
  }
}

const instance = new Clicker(".element");