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.md35
1 files changed, 32 insertions, 3 deletions
diff --git a/tools/node_modules/eslint/node_modules/onetime/readme.md b/tools/node_modules/eslint/node_modules/onetime/readme.md
index 95eb3b7c9e..9ecd1b24db 100644
--- a/tools/node_modules/eslint/node_modules/onetime/readme.md
+++ b/tools/node_modules/eslint/node_modules/onetime/readme.md
@@ -4,29 +4,35 @@
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`.*
+*Unlike the module [once](https://github.com/isaacs/once), this one isn't naughty and extending `Function.prototype`.*
## Install
```
-$ npm install --save onetime
+$ npm install onetime
```
## Usage
```js
+const onetime = require('onetime');
+
let i = 0;
-const foo = onetime(() => i++);
+const foo = onetime(() => ++i);
foo(); //=> 0
foo(); //=> 0
foo(); //=> 0
+
+onetime.callCount(foo); //=> 3
```
```js
+const onetime = require('onetime');
+
const foo = onetime(() => {}, {throw: true});
foo();
@@ -59,6 +65,29 @@ Default: `false`
Throw an error when called more than once.
+### onetime.callCount(fn)
+
+Returns a number representing how many times `fn` has been called.
+
+Note: It throws an error if you pass in a function that is not wrapped by `onetime`.
+
+```js
+const foo = onetime(() => {});
+
+foo();
+foo();
+foo();
+
+console.log(onetime.callCount(foo));
+//=> 3
+```
+
+#### fn
+
+Type: `Function`
+
+Function to get call count from.
+
## License