funcs-js
Version:
Function wrappers for enhanced behavior.
73 lines (50 loc) • 3.33 kB
Markdown
# {"gitdown": "gitinfo", "name": "name"}
[](https://www.npmjs.org/package/{"gitdown": "gitinfo", "name": "name"}) [](https://github.com/{"gitdown": "gitinfo", "name": "username"}/{"gitdown": "gitinfo", "name": "name"}/actions) [](https://coveralls.io/r/{"gitdown": "gitinfo", "name": "username"}/{"gitdown": "gitinfo", "name": "name"}) [](https://snyk.io/test/github/{"gitdown": "gitinfo", "name": "username"}/{"gitdown": "gitinfo", "name": "name"}) [](http://inch-ci.org/github/{"gitdown": "gitinfo", "name": "username"}/{"gitdown": "gitinfo", "name": "name"}) [](https://github.com/{"gitdown": "gitinfo", "name": "username"}/{"gitdown": "gitinfo", "name": "name"}/blob/master/LICENSE) [](https://www.npmjs.org/package/{"gitdown": "gitinfo", "name": "name"})
> Function wrappers for enhanced behavior.
* [Overview](#overview)
* [Usage](#usage)
* [once](#usage-once)
* [maxTimes](#usage-maxTimes)
* [async](#usage-async)
* [delay](#usage-delay)
* [isFunction](#usage-isFunction)
* [noop](#usage-noop)
* [ensure](#usage-ensure)
* [Installation](#installation)
* [API Documentation](docs/api.md)
* [Contributing](.github/CONTRIBUTING.md)
* [Release History](#history)
* [License](#license)
<a name="overview"></a>
## Overview
The {"gitdown": "gitinfo", "name": "name"} provides different utility functions which enable to wrap functions and modify their behavior.
This library requires no external dependencies, and it is supported for both browser and node.js environments.
<a name="usage"></a>
## Usage
In order to use the library in browser, you first must add the relevant dependency:
```html
<script type="text/javascript" src="funcs.js"></script>
```
When using an AMD loader (such as RequireJS) or CommonJS type loader, the funcs object is not automatically defined on the window scope.
For node.js, simply require the module as follows:
````js
var funcs = require('funcs-js');
````
<a name="usage-once"></a>
<a name="usage-maxTimes"></a>
<a name="usage-async"></a>
<a name="usage-delay"></a>
<a name="usage-isFunction"></a>
<a name="usage-noop"></a>
<a name="usage-ensure"></a>
<a name="installation"></a>
## Installation
Run npm install in your project as follows:
```sh
npm install --save {"gitdown": "gitinfo", "name": "name"}
```
Or if you are using bower, you can install it as follows:
```sh
bower install {"gitdown": "gitinfo", "name": "name"} --save
```
{"gitdown": "include", "file": "./README-footer-template.md"}