Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reactjs/react-timer-mixin

TimerMixin provides timer functions for executing code in the future that are safely cleaned up when the component unmounts
https://github.com/reactjs/react-timer-mixin

Last synced: 6 days ago
JSON representation

TimerMixin provides timer functions for executing code in the future that are safely cleaned up when the component unmounts

Awesome Lists containing this project

README 

        
# react-timer-mixin



Using bare setTimeout, setInterval, setImmediate and requestAnimationFrame calls

is very dangerous because if you forget to cancel the request before the

component is unmounted, you risk the callback throwing an exception.



If you include TimerMixin, then you can replace your calls to

`setTimeout(fn, 500)` with `this.setTimeout(fn, 500)` (just prepend `this.`) and

everything will be properly cleaned up for you.



## Installation



Install the module directly from npm:



```

npm install react-timer-mixin

```



## Example



```js

var React = require('react');

var TimerMixin = require('react-timer-mixin');



var Component = React.createClass({

  mixins: [TimerMixin],

  componentDidMount() {

    this.setTimeout(

      () => { console.log('I do not leak!'); },

      500

    );

  }

});

```