summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/onetime/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/node_modules/onetime/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/onetime/readme.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/onetime/readme.md b/tools/node_modules/eslint/node_modules/onetime/readme.md
new file mode 100644
index 0000000000..95eb3b7c9e
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/onetime/readme.md
@@ -0,0 +1,65 @@
+# onetime [![Build Status](https://travis-ci.org/sindresorhus/onetime.svg?branch=master)](https://travis-ci.org/sindresorhus/onetime)
+
+> Ensure a function is only called 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
+```
+
+```js
+const foo = onetime(() => {}, {throw: true});
+
+foo();
+
+foo();
+//=> Error: Function `foo` can only be called once
+```
+
+
+## API
+
+### onetime(fn, [options])
+
+Returns a function that only calls `fn` once.
+
+#### fn
+
+Type: `Function`
+
+Function that should only be called once.
+
+#### options
+
+Type: `Object`
+
+##### throw
+
+Type: `boolean`<br>
+Default: `false`
+
+Throw an error when called more than once.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)