diff options
Diffstat (limited to 'tools/eslint/node_modules/onetime/readme.md')
| -rw-r--r-- | tools/eslint/node_modules/onetime/readme.md | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/tools/eslint/node_modules/onetime/readme.md b/tools/eslint/node_modules/onetime/readme.md index e27d2bcb47..95eb3b7c9e 100644 --- a/tools/eslint/node_modules/onetime/readme.md +++ b/tools/eslint/node_modules/onetime/readme.md @@ -1,6 +1,6 @@ # onetime [](https://travis-ci.org/sindresorhus/onetime) -> Only call a function once +> Ensure a function is only called once When called multiple times it will return the return value from the first call. @@ -26,27 +26,40 @@ foo(); //=> 0 foo(); //=> 0 ``` +```js +const foo = onetime(() => {}, {throw: true}); + +foo(); + +foo(); +//=> Error: Function `foo` can only be called once +``` + ## API -### onetime(function, [shouldThrow]) +### onetime(fn, [options]) -#### function +Returns a function that only calls `fn` once. -Type: `function` +#### fn + +Type: `Function` Function that should only be called once. -#### shouldThrow +#### options -Type: `boolean` -Default: `false` +Type: `Object` - +##### throw + +Type: `boolean`<br> +Default: `false` -Set to `true` if you want it to fail with a nice and descriptive error when called more than once. +Throw an error when called more than once. ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT © [Sindre Sorhus](https://sindresorhus.com) |