chizu 0.2.72 → 0.4.0

package/dist/cache/index.d.ts

@@ -1,77 +0,0 @@
-import { Filter, CacheId, ChanneledCacheId } from '../types/index.ts';
-export type { CacheId, ChanneledCacheId };
-/**
- * Creates a typed cache entry identifier for use with `context.actions.cacheable`
- * and `context.actions.invalidate`.
- *
- * Each call produces a unique identity. The first type parameter `T` binds the
- * entry to a specific value type, ensuring that `cacheable` callbacks return the
- * correct type.
- *
- * When called with only `T`, the entry is unchanneled — a single cache slot.
- * When called with `T` and `C`, the entry is channeled — independent cache
- * slots per channel value.
- *
- * @template T - The cached value type.
- * @template C - The channel type, constrained to `Filter`.
- * @returns A cache entry identifier for use with `cacheable` and `invalidate`.
- *
- * @example
- * ```ts
- * import { Entry } from "chizu";
- *
- * class CacheStore {
- *   // Unchanneled — single cache slot
- *   static Pairs = Entry<CryptoPair[]>();
- *
- *   // Channeled &mdash; independent slot per UserId
- *   static User = Entry<User, { UserId: number }>();
- * }
- *
- * // Unchanneled usage
- * await context.actions.cacheable(CacheStore.Pairs, 30_000, async () => ...);
- *
- * // Channeled usage
- * await context.actions.cacheable(CacheStore.User({ UserId: 5 }), 60_000, async () => ...);
- *
- * // Invalidate
- * context.actions.invalidate(CacheStore.Pairs);
- * context.actions.invalidate(CacheStore.User({ UserId: 5 }));
- * ```
- */
-export declare function Entry<T>(): CacheId<T>;
-export declare function Entry<T, C extends Filter>(): CacheId<T, C>;
-/**
- * Extracts the identity symbol from a plain or channeled cache entry.
- */
-export declare function getCacheSymbol(entry: CacheId | ChanneledCacheId): symbol;
-/**
- * Type guard that returns `true` when the entry is a channeled cache identifier.
- */
-export declare function isChanneledCacheId(entry: CacheId | ChanneledCacheId): entry is ChanneledCacheId;
-/**
- * Serialises a channel object into a deterministic string key.
- * Keys are sorted alphabetically for deterministic output.
- * Returns an empty string for unchanneled operations.
- */
-export declare function serializeChannel(channel?: Filter): string;
-/**
- * Builds the cache Map key from an entry identifier.
- * Combines the symbol description (unique per Entry call) with the
- * serialised channel string for channeled entries.
- */
-export declare function getCacheKey(entry: CacheId | ChanneledCacheId): string;
-/**
- * Unwraps one layer of `Option` or `Result` from a value.
- *
- * - `Some(value)` (non-null/undefined) &rarr; `{ ok: true, value }`
- * - `None` (null/undefined) &rarr; `{ ok: false }`
- * - `Ok(value)` (TAG 0) &rarr; `{ ok: true, value: _0 }`
- * - `Error(value)` (TAG 1) &rarr; `{ ok: false }`
- */
-export declare function unwrap(result: unknown): {
-    ok: true;
-    value: unknown;
-} | {
-    ok: false;
-};