# cancelable

**Repository Path**: mirrors_FGRibreau/cancelable

## Basic Information

- **Project Name**: cancelable
- **Description**: Cancelable JavaScript functions
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Cancelable [![Build Status](https://drone.io/github.com/FGRibreau/cancelable/status.png)](https://drone.io/github.com/FGRibreau/cancelable/latest)

Cancelable functions for JavaScript.

## Getting Started
Install the module with: `npm install cancelable`

## Examples

```javascript
var Cancelable = require('cancelable');
var fn = Cancelable(function(){console.log('plop');});
fn(); // print "plop"
fn.cancel();
fn(); // do nothing
```

Cancelable is compatible with [Underscore](http://underscorejs.org/) and [Lodash](http://lodash.com/) as a mixin.

```javascript
var _ = require('underscore');
_.mixin(require('cancelable').exports());
var fn = _.cancelable(function(){console.log('plop');});
fn(); // print "plop"
fn.cancel();
fn(); // do nothing
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).

## Release History
v0.1.0 3/17/2013 Initial release.

## Donate
[Donate Bitcoins](https://coinbase.com/checkouts/fc3041b9d8116e0b98e7d243c4727a30)

## License
Copyright (c) 2013 Francois-Guillaume Ribreau
Licensed under the MIT license.