@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
84 lines (83 loc) • 3.51 kB
TypeScript
/**
* @module SharedLock
*/
import { type IReadableContext } from "../../../../execution-context/contracts/_module.js";
import { type ISharedLockAdapter, type ISharedLockAdapterState, type SharedLockAcquireSettings } from "../../../../shared-lock/contracts/_module.js";
import { type TimeSpan } from "../../../../time-span/implementations/_module.js";
import { type IDeinitizable } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/memory-shared-lock-adapter"`
* @group Adapters
*/
export type MemorySharedWriterLockData = {
owner: string;
hasExpiration: true;
timeoutId: string | number | NodeJS.Timeout;
expiration: Date;
} | {
owner: string;
hasExpiration: false;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/memory-shared-lock-adapter"`
* @group Adapters
*/
export type MemorySharedReaderSemaphoreData = {
limit: number;
slots: Map<string, {
timeoutId: string | number | NodeJS.Timeout | null;
expiration: Date | null;
}>;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/memory-shared-lock-adapter"`
* @group Adapters
*/
export type MemorySharedLockData = {
writerLock: MemorySharedWriterLockData | null;
readerSemaphore: MemorySharedReaderSemaphoreData | null;
};
/**
* Note the `MemorySharedLockAdapter` is limited to single process usage and cannot be shared across multiple servers or different processes.
* This adapter is meant for easily faking{@link ISharedLockFactory | `ISharedLockFactory`} for testing.
*
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/memory-shared-lock-adapter"`
* @group Adapters
*/
export declare class MemorySharedLockAdapter implements ISharedLockAdapter, IDeinitizable {
private readonly map;
/**
* @example
* ```ts
* import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter";
*
* const sharedLockAdapter = new MemorySharedLockAdapter();
* ```
* You can also provide an `Map`.
* @example
* ```ts
* import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter";
*
* const map = new Map<any, any>();
* const sharedLockAdapter = new MemorySharedLockAdapter(map);
* ```
*/
constructor(map?: Map<string, MemorySharedLockData>);
/**
* Removes all in-memory shared-lock data.
*/
deInit(): Promise<void>;
acquireWriter(_context: IReadableContext, key: string, lockId: string, ttl: TimeSpan | null): Promise<boolean>;
releaseWriter(_context: IReadableContext, key: string, lockId: string): Promise<boolean>;
forceReleaseWriter(_context: IReadableContext, key: string): Promise<boolean>;
refreshWriter(_context: IReadableContext, key: string, lockId: string, ttl: TimeSpan): Promise<boolean>;
acquireReader(settings: SharedLockAcquireSettings): Promise<boolean>;
releaseReader(_context: IReadableContext, key: string, lockId: string): Promise<boolean>;
forceReleaseAllReaders(_context: IReadableContext, key: string): Promise<boolean>;
refreshReader(_context: IReadableContext, key: string, lockId: string, ttl: TimeSpan): Promise<boolean>;
forceRelease(context: IReadableContext, key: string): Promise<boolean>;
private static extractReaderState;
private static extractWriterState_;
private static extractActiveWriterState;
getState(_context: IReadableContext, key: string): Promise<ISharedLockAdapterState | null>;
}