node/tools/eslint/node_modules/onetime/readme.md
Rich Trott 7a8dd69e1c tools: update ESLint to 2.9.0
ESLint 2.9.0 fixes some minor bugs that we have been experiencing and
introduces some new rules that we may wish to consider.

PR-URL: https://github.com/nodejs/node/pull/6498
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
2016-05-04 10:26:25 -07:00

52 lines
892 B
Markdown

# onetime [![Build Status](https://travis-ci.org/sindresorhus/onetime.svg?branch=master)](https://travis-ci.org/sindresorhus/onetime)
> Only call a function once
When called multiple times it will return the return value from the first call.
*Unlike the module [once](https://github.com/isaacs/once), this one isn't naughty extending `Function.prototype`.*
## Install
```
$ npm install --save onetime
```
## Usage
```js
let i = 0;
const foo = onetime(() => i++);
foo(); //=> 0
foo(); //=> 0
foo(); //=> 0
```
## API
### onetime(function, [shouldThrow])
#### function
Type: `function`
Function that should only be called once.
#### shouldThrow
Type: `boolean`
Default: `false`
![](screenshot-shouldthrow.png)
Set to `true` if you want it to fail with a nice and descriptive error when called more than once.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)