diff options
author | Minteck <contact@minteck.org> | 2022-04-17 17:37:10 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-04-17 17:37:10 +0200 |
commit | 4081c2036a5af21519095da1b8b99c507b0fba93 (patch) | |
tree | fc95894e74c84d4d34c0d761837e8d6175829dd7 /node_modules/onetime/index.d.ts | |
parent | 637ca7ba746c0241aaec79b79349d5dac4ec7408 (diff) | |
download | twilight-4081c2036a5af21519095da1b8b99c507b0fba93.tar.gz twilight-4081c2036a5af21519095da1b8b99c507b0fba93.tar.bz2 twilight-4081c2036a5af21519095da1b8b99c507b0fba93.zip |
Deprecation
Diffstat (limited to 'node_modules/onetime/index.d.ts')
-rw-r--r-- | node_modules/onetime/index.d.ts | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/node_modules/onetime/index.d.ts b/node_modules/onetime/index.d.ts deleted file mode 100644 index ea84cab..0000000 --- a/node_modules/onetime/index.d.ts +++ /dev/null @@ -1,64 +0,0 @@ -declare namespace onetime { - interface Options { - /** - Throw an error when called more than once. - - @default false - */ - throw?: boolean; - } -} - -declare const onetime: { - /** - Ensure a function is only called once. When called multiple times it will return the return value from the first call. - - @param fn - Function that should only be called once. - @returns A function that only calls `fn` once. - - @example - ``` - import onetime = require('onetime'); - - let i = 0; - - const foo = onetime(() => ++i); - - foo(); //=> 1 - foo(); //=> 1 - foo(); //=> 1 - - onetime.callCount(foo); //=> 3 - ``` - */ - <ArgumentsType extends unknown[], ReturnType>( - fn: (...arguments: ArgumentsType) => ReturnType, - options?: onetime.Options - ): (...arguments: ArgumentsType) => ReturnType; - - /** - Get the number of times `fn` has been called. - - @param fn - Function to get call count from. - @returns A number representing how many times `fn` has been called. - - @example - ``` - import onetime = require('onetime'); - - const foo = onetime(() => {}); - foo(); - foo(); - foo(); - - console.log(onetime.callCount(foo)); - //=> 3 - ``` - */ - callCount(fn: (...arguments: any[]) => unknown): number; - - // TODO: Remove this for the next major release - default: typeof onetime; -}; - -export = onetime; |