Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cachebind

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cachebind

Cache/memoize result of bind function with its context or/and args (no-shims version)

  • 2.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

CacheBind

It caches/memoizes result of binding function with its context and args. For the same set it returns identical result every time.

This version doesn't use any shims or polyfills. If you don't have their substitutes in your projects you may need to use version with the shims bindcache instead of this.

Motivation

It solves the problem of unnecessary renders cased by use of Function.prototype.bind function in render method. It also keep up with jsx-no-bind rule which is used to detect such issues.

class MyComponent extends Component {
    onChange() {
        // ...    
    }

    render () {
        const { param } = this.props
        return (
            <div>
                <SomeComponent someParam={"value"}>
                <OtherComponent callback={this.onChange.bind(this, param, "MyComponent")}/>
            </div>    
        )
    }
}

This code will make OtherComponent to render every time this render function will be fired.

Api

If you need to bind context:

bind(context: any, fn: () => void, args?: any | Array<any>)

If you don't need context:

bindArgs(fn: () => void, args?: any | Array<any>)
  • context — context,
  • fn — function to bind,
  • args — any number of arguments of any type divided by commas.

Usage

npm install cachebind
import { bind } from "cachebind"

class MyComponent extends Component {
    onChange(param, component) {
        // ...
    }

    render () {
        const { param } = this.props
        return (
            <div>
                <SomeComponent someParam={"value"}>
                <OtherComponent callback={bind(this, this.onChange, param, "MyComponent")}/>
            </div>    
        )
    }
}

If you don't need the context of the function or it is already present/binded you can use bindArgs util instead. The previous code can be written like this.

import { bindArgs } from "cachebind"

class MyComponent extends Component {
    onChange = (param, component) => { /* ... */ }

    render () {
        const { param } = this.props
        return (
            <div>
                <SomeComponent someParam={"value"}>
                <OtherComponent callback={bindArgs(this.onChange, param, "MyComponent")}/>
            </div>    
        )
    }
}

bindArgs(fn, ...args) is equal to bind(undefined, fn, ...args)

How it works

The util caches results of binding in native WeakMap so the items with no references can be garbage collected.

Tips

bind util lets you feed it with context for the function. You can use arrow function (as it was shown above), or bind context once with decorator:

class MyComponent extends Component {
    @autoBind
    onChange(param, component) {
        // ...
    }
    // ...
}

or cache the result of binding in constructor:

class MyComponent extends Component {
   constructor(props) {
       super(props)
       this.onChange = this.onChange.bind(this)
   }

   onChange(param, component) {
       // ...
   }
   // ...
}

It is not suggested to use this utils instead of Function.prototype.bind in every case. The original bind function is still faster. For example if you need to bind context with no args or your params are static for the component you can bind it one time in constructor function. But it will help you great deal in case of unnecessary renders of react components.

Keywords

FAQs

Package last updated on 16 Jul 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc