mirror of
https://github.com/github/codeql-action.git
synced 2025-12-26 17:20:10 +08:00
* Bump @ava/typescript from 3.0.1 to 4.0.0 Bumps [@ava/typescript](https://github.com/avajs/typescript) from 3.0.1 to 4.0.0. - [Release notes](https://github.com/avajs/typescript/releases) - [Commits](https://github.com/avajs/typescript/compare/v3.0.1...v4.0.0) --- updated-dependencies: - dependency-name: "@ava/typescript" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Update checked-in dependencies --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions@github.com>
60 lines
1.1 KiB
TypeScript
60 lines
1.1 KiB
TypeScript
export interface Options {
|
|
/**
|
|
Throw an error when called more than once.
|
|
|
|
@default false
|
|
*/
|
|
readonly 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 from 'onetime';
|
|
|
|
let index = 0;
|
|
|
|
const foo = onetime(() => ++index);
|
|
|
|
foo(); //=> 1
|
|
foo(); //=> 1
|
|
foo(); //=> 1
|
|
|
|
onetime.callCount(foo); //=> 3
|
|
```
|
|
*/
|
|
<ArgumentsType extends unknown[], ReturnType>(
|
|
fn: (...arguments: ArgumentsType) => ReturnType,
|
|
options?: 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 from 'onetime';
|
|
|
|
const foo = onetime(() => {});
|
|
foo();
|
|
foo();
|
|
foo();
|
|
|
|
console.log(onetime.callCount(foo));
|
|
//=> 3
|
|
```
|
|
*/
|
|
callCount(fn: (...arguments: any[]) => unknown): number;
|
|
};
|
|
|
|
export default onetime;
|