Miss any of our Open RFC calls?Watch the recordings here! »

@loopmode/bind

2.0.0 • Public • Published

@loopmode/bind

A scope binding mechanism for javascript classes.


Default matcher

Out of the box, the function will bind all methods that have a name starting with on followed by uppercase character, or handle followed by either uppercase character or underscore.

You are encouraged to use a naming convention like that (e.g. handleClick), because then you don't need to pass any arguments but the class instance itself:

import bind from '@loopmode/bind';
 
export class Demo {
    constructor() {
        bind(this);
        window.addEventListener('click', this.handleClick);
    }
    handleClick(event) {
        console.log('handleClick', this, event);
    }
}

Special matchers

  • * bind all methods, regardless of their name
  • A matcher can be a function that receives the function name and returns a boolean

Custom matchers

You can also pass additional arguments to specify custom matchers:

import bind from '@loopmode/bind';
 
export class Demo {
    constructor() {
        bind(this, /^handle/, 'init');
    }
    init() {
        window.addEventListener('click', this.handleClick);
        window.addEventListener('change', this.handleChange);
    }
    destroy() {
        window.removeEventListener('click', this.handleClick);
        window.removeEventListener('change', this.handleChange);
    }
    handleClick(event) {
        console.log('handleClick', this, event);
    }
    handleChange(event) {
        console.log('handleChange', this, event);
    }
}
 
const demo - new Demo();
document.addEventListener('DOMContentLoaded', demo.init)

Some more examples:

bind(this, /^on/); // match `onClick`, `onChange` etc, using RegExp object
 
bind(this, '^on'); // same as before, but with string regex
 
bind(this, 'on'); // string matcher, will match both `onClick` and e.g. `createBaboon`
 
bind(this, 'on$'); // Will match `createBaboon` but not `onClick`
 
bind(this, /^handle/, /^on/); // Will match all methods starting with `handle` or `on`, multiple arguments
 
bind(this, [/^handle/, /^on/]); // Same as before, but with a single array as argument
 
bind(this, [/^handle/, 'renderConfirmDialog']); // Typical real-world-case, match handlers but also some specific render method that gets injected into a child

Custom wrapper

In case you do have a naming convention, but it's not handle*, you should create your own module with a wrapper function that provides the appropriate matcher, and use that - without passing extra arguments.
For example, if you typically use onEvent rather than handleEvent, your own bind module might export this wrapper function:

import bind from '@loopmode/bind';
export default instance => bind(instance, /^on/);

React components

You will not run into troubles with e.g. React components - lifecycle methods are not bound unless you defined an explicit matcher for that (e.g. render or /^componentDid/ etc).

import React from 'react';
import bind from '@loopmode/bind';
 
export class bind extends React.Component {
    state = {
        clickCount: 0
    };
    constructor(props) {
        super(props);
        bind(this);
    }
    render() {
        return <button onClick={this.handleClick}>click me</button>;
    }
    handleClick(event) {
        this.setState({ clickCount: this.state.clickCount + 1 });
    }
}

Install

npm i @loopmode/bind

DownloadsWeekly Downloads

1

Version

2.0.0

License

MIT

Unpacked Size

12.1 kB

Total Files

7

Last publish

Collaborators

  • avatar