@daiso-tech/core/dist/semaphore/contracts/semaphore.events.d.ts

The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.

/**
 * @module Semaphore
 */
import { type ISemaphoreStateMethods } from "../../semaphore/contracts/semaphore.contract.js";
/**
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type SemaphoreEventBase = {
    semaphore: ISemaphoreStateMethods;
};
/**
 * The event is dispatched when a semaphore slot is acquired.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type AcquiredSemaphoreEvent = SemaphoreEventBase;
/**
 * The event is dispatched when a semaphore slot is released.
 * Note this event is only dispatched when the semaphore slot is released and not when the semaphore slot expired.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type ReleasedSemaphoreEvent = SemaphoreEventBase;
/**
 * The event is dispatched when all slot of semaphore are released.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type AllForceReleasedSemaphoreEvent = SemaphoreEventBase & {
    hasReleased: boolean;
};
/**
 * The event is dispatched when trying to refresh a semaphore slot that is already expired.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type FailedRefreshSemaphoreEvent = SemaphoreEventBase;
/**
 * The event is dispatched when trying to release a semaphore slot that is already expired.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type FailedReleaseSemaphoreEvent = SemaphoreEventBase;
/**
 * The event is dispatched when trying to acquire a semaphore slot when all slots are unavailable.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type LimitReachedSemaphoreEvent = SemaphoreEventBase;
/**
 * The event is dispatched when a semaphore slot is refreshed.
 *
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type RefreshedSemaphoreEvent = SemaphoreEventBase;
/**
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type UnexpectedErrorSemaphoreEvent = SemaphoreEventBase & {
    error: unknown;
};
/**
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export declare const SEMAPHORE_EVENTS: {
    readonly ACQUIRED: "ACQUIRED";
    readonly RELEASED: "RELEASED";
    readonly ALL_FORCE_RELEASED: "ALL_FORCE_RELEASED";
    readonly FAILED_RELEASE: "FAILED_RELEASE";
    readonly FAILED_REFRESH: "FAILED_REFRESH";
    readonly LIMIT_REACHED: "LIMIT_REACHED";
    readonly REFRESHED: "REFRESHED";
    readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
};
/**
 * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
 * @group Events
 */
export type SemaphoreEventMap = {
    [SEMAPHORE_EVENTS.ACQUIRED]: AcquiredSemaphoreEvent;
    [SEMAPHORE_EVENTS.RELEASED]: ReleasedSemaphoreEvent;
    [SEMAPHORE_EVENTS.ALL_FORCE_RELEASED]: AllForceReleasedSemaphoreEvent;
    [SEMAPHORE_EVENTS.FAILED_RELEASE]: FailedReleaseSemaphoreEvent;
    [SEMAPHORE_EVENTS.FAILED_REFRESH]: FailedRefreshSemaphoreEvent;
    [SEMAPHORE_EVENTS.LIMIT_REACHED]: LimitReachedSemaphoreEvent;
    [SEMAPHORE_EVENTS.REFRESHED]: RefreshedSemaphoreEvent;
    [SEMAPHORE_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorSemaphoreEvent;
};