tick-cache 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,64 @@
+interface TimeSource {
+    nowMs(): number;
+}
+
+type DisposeReason = "ttl" | "lru" | "delete" | "clear" | "set";
+interface Stats {
+    size: number;
+}
+interface Options<K extends string | number, V> {
+    maxEntries: number;
+    tickMs?: number;
+    wheelSize?: number;
+    updateTTLOnGet?: boolean;
+    budgetPerTick?: number;
+    /**
+     * When true (default), a background interval will automatically process expirations.
+     * When false, expirations are only processed during cache operations (get/set/has/delete).
+     * Use false to avoid background timers if you access the cache frequently enough.
+     */
+    ttlAutopurge?: boolean;
+    /**
+     * Optional custom time source (primarily for testing).
+     * Defaults to performance.now() if not provided.
+     */
+    time?: TimeSource;
+    /**
+     * Optional callback invoked when an entry is disposed (evicted, deleted, cleared, or replaced).
+     */
+    onDispose?: (key: K, value: V, reason: DisposeReason) => void;
+}
+
+declare class TtlWheelCache<K extends string | number, V> {
+    private readonly store;
+    private readonly wheel;
+    private readonly ticker;
+    private readonly keyIndex;
+    private readonly lru;
+    private readonly maxEntries;
+    private readonly updateTTLOnGet;
+    private readonly ttlAutopurge;
+    private readonly tickMs;
+    private readonly onDispose?;
+    private intervalId?;
+    constructor(options: Options<K, V>);
+    set(key: K, value: V, ttlMs: number): void;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    delete(key: K): boolean;
+    clear(): void;
+    size(): number;
+    stats(): Stats;
+    close(): void;
+    /**
+     * Advance the timer wheel and process expirations.
+     * Called automatically in active mode (ttlAutopurge=false).
+     */
+    private advanceWheel;
+    private removeEntry;
+    private onExpireEntry;
+    private evictLru;
+    private startCleanupInterval;
+}
+
+export { type DisposeReason, type Options, type Stats, TtlWheelCache };

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+interface TimeSource {
+    nowMs(): number;
+}
+
+type DisposeReason = "ttl" | "lru" | "delete" | "clear" | "set";
+interface Stats {
+    size: number;
+}
+interface Options<K extends string | number, V> {
+    maxEntries: number;
+    tickMs?: number;
+    wheelSize?: number;
+    updateTTLOnGet?: boolean;
+    budgetPerTick?: number;
+    /**
+     * When true (default), a background interval will automatically process expirations.
+     * When false, expirations are only processed during cache operations (get/set/has/delete).
+     * Use false to avoid background timers if you access the cache frequently enough.
+     */
+    ttlAutopurge?: boolean;
+    /**
+     * Optional custom time source (primarily for testing).
+     * Defaults to performance.now() if not provided.
+     */
+    time?: TimeSource;
+    /**
+     * Optional callback invoked when an entry is disposed (evicted, deleted, cleared, or replaced).
+     */
+    onDispose?: (key: K, value: V, reason: DisposeReason) => void;
+}
+
+declare class TtlWheelCache<K extends string | number, V> {
+    private readonly store;
+    private readonly wheel;
+    private readonly ticker;
+    private readonly keyIndex;
+    private readonly lru;
+    private readonly maxEntries;
+    private readonly updateTTLOnGet;
+    private readonly ttlAutopurge;
+    private readonly tickMs;
+    private readonly onDispose?;
+    private intervalId?;
+    constructor(options: Options<K, V>);
+    set(key: K, value: V, ttlMs: number): void;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    delete(key: K): boolean;
+    clear(): void;
+    size(): number;
+    stats(): Stats;
+    close(): void;
+    /**
+     * Advance the timer wheel and process expirations.
+     * Called automatically in active mode (ttlAutopurge=false).
+     */
+    private advanceWheel;
+    private removeEntry;
+    private onExpireEntry;
+    private evictLru;
+    private startCleanupInterval;
+}
+
+export { type DisposeReason, type Options, type Stats, TtlWheelCache };