@daiso-tech/core/dist/cache/contracts/cache.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 Cache
 */
import { type Key } from "../../namespace/_module.js";
import { type TimeSpan } from "../../time-span/implementations/_module.js";
/**
 * The event is dispatched when key is found.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type FoundCacheEvent<TType = unknown> = {
    key: Key;
    value: TType;
};
/**
 * The event is dispatched when key is not found.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type NotFoundCacheEvent = {
    key: Key;
};
/**
 * The event is dispatched when key is added.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type AddedCacheEvent<TType = unknown> = {
    key: Key;
    value: TType;
    ttl: TimeSpan | null;
};
/**
 * The event is dispatched when key is updated.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type UpdatedCacheEvent<TType = unknown> = {
    key: Key;
    value: TType;
};
/**
 * The event is dispatched when key is removed.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type RemovedCacheEvent = {
    key: Key;
};
/**
 * The event is dispatched when key is incremented.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type IncrementedCacheEvent = {
    key: Key;
    value: number;
};
/**
 * The event is dispatched when key is decremented.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type DecrementedCacheEvent = {
    key: Key;
    value: number;
};
/**
 * The event is dispatched when all keys all cleared of the cache.
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type ClearedCacheEvent = {};
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type UnexpectedErrorCacheEvent = {
    keys?: string[];
    value?: unknown;
    method: string;
    error: unknown;
};
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export declare const CACHE_EVENTS: {
    readonly FOUND: "FOUND";
    readonly NOT_FOUND: "NOT_FOUND";
    readonly ADDED: "ADDED";
    readonly UPDATED: "UPDATED";
    readonly REMOVED: "REMOVED";
    readonly INCREMENTED: "INCREMENTED";
    readonly DECREMENTED: "DECREMENTED";
    readonly CLEARED: "CLEARED";
    readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
};
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
 * @group Events
 */
export type CacheEventMap<TType = unknown> = {
    [CACHE_EVENTS.FOUND]: FoundCacheEvent<TType>;
    [CACHE_EVENTS.NOT_FOUND]: NotFoundCacheEvent;
    [CACHE_EVENTS.ADDED]: AddedCacheEvent<TType>;
    [CACHE_EVENTS.UPDATED]: UpdatedCacheEvent<TType>;
    [CACHE_EVENTS.REMOVED]: RemovedCacheEvent;
    [CACHE_EVENTS.INCREMENTED]: IncrementedCacheEvent;
    [CACHE_EVENTS.DECREMENTED]: DecrementedCacheEvent;
    [CACHE_EVENTS.CLEARED]: ClearedCacheEvent;
    [CACHE_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorCacheEvent;
};