Interface Gate

interface Gate {
    enter<T>(fn: () => T, label?: string): T;
    held(): boolean;
    run<T>(fn: () => T | Promise<T>): Promise<T>;
    stats(): GateStats;
}

Index

Methods

enter held run stats

Methods

enter

enter<T>(fn: () => T, label?: string): T
Runs now, or throws ReentrancyError if a call is in flight.
Type Parameters
- T
Parameters
- fn: () => T
- Optionallabel: string
Returns T
- Defined in npm/src/gate.ts:18

held

held(): boolean
True while a call is running, including one parked in a suspension.

Returns boolean
- Defined in npm/src/gate.ts:20

run

run<T>(fn: () => T | Promise<T>): Promise<T>
Queues behind whatever is outstanding.
Type Parameters
- T
Parameters
- fn: () => T | Promise<T>
Returns Promise<T>
- Defined in npm/src/gate.ts:16

stats

stats(): GateStats
Returns GateStats
- Defined in npm/src/gate.ts:21