Permalink
Cannot retrieve contributors at this time
64 lines (49 sloc)
1.23 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/run-applescript/node_modules/onetime/index.d.ts
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; |