From 26105034da4fcce7ac883c899d781f016559310d Mon Sep 17 00:00:00 2001 From: ruki Date: Thu, 8 Nov 2018 00:38:48 +0800 Subject: switch to vuepress --- node_modules/onetime/readme.md | 65 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 node_modules/onetime/readme.md (limited to 'node_modules/onetime/readme.md') diff --git a/node_modules/onetime/readme.md b/node_modules/onetime/readme.md new file mode 100644 index 00000000..95eb3b7c --- /dev/null +++ b/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`
+Default: `false` + +Throw an error when called more than once. + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) -- cgit v1.2.3