# autobind-decorator

**Repository Path**: mirrors_stevemao/autobind-decorator

## Basic Information

- **Project Name**: autobind-decorator
- **Description**: Decorator to automatically bind methods to class instances
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2025-11-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# autobind decorator

A class or method decorator which binds methods to the instance
so `this` is always correct, even when the method is detached.

This is particularly useful for situations like React components, where 
you often pass methods as event handlers and would otherwise need to 
`.bind(this)`.
```
Before:
<button onClick={ this.handleClick.bind(this) }></button>

After:
<button onClick={ this.handleClick }></button>
```

As decorators are a part of future ES2016 standard they can only be used with
transpilers such as [Babel](http://babeljs.io).

**Note Babel 6 users:**
The implementation of the decorator transform is currently on hold as the syntax 
is not final. If you would like to use this project with Babel 6.0, you may use 
[babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy)
which implement Babel 5 decorator transform for Babel 6.

Installation:

    % npm install autobind-decorator

Example:

    import autobind from 'autobind-decorator'

    class Component {

      constructor(value) {
        this.value = value
      }

      @autobind
      method() {
        return this.value
      }
    }

    let component = new Component(42)
    let method = component.method // .bind(component) isn't needed!
    method() // returns 42


    // Also usable on the class to bind all methods

    @autobind
    class Component { }