@apiratorjs/locking
Version:
A lightweight library providing both local and distributed locking primitives (mutexes, semaphores, and read-write locks) for managing concurrency in Node.js.
19 lines • 871 B
TypeScript
import { AcquireParams, DistributedMutexConstructorProps, DistributedMutexFactory, IDistributedMutex, IReleaser, MutexToken } from "./types";
export declare class DistributedMutex implements IDistributedMutex {
static factory: DistributedMutexFactory;
private readonly _implementation;
constructor(props: DistributedMutexConstructorProps);
waitForUnlock(): Promise<void>;
get isDestroyed(): boolean;
runExclusive<T>(fn: () => Promise<T> | T): Promise<T>;
runExclusive<T>(params: AcquireParams, fn: () => Promise<T> | T): Promise<T>;
destroy(): Promise<void>;
get name(): string;
get implementation(): string;
acquire(params?: {
timeoutMs?: number;
}): Promise<IReleaser<MutexToken>>;
cancel(errMessage?: string): Promise<void>;
isLocked(): Promise<boolean>;
}
//# sourceMappingURL=distributed-mutex.d.ts.map