/** * @module Cache */ import { type ICache, type ICacheAdapter, type ICacheResolver } from "../../../../cache/contracts/_module.js"; import { type CacheSettingsBase } from "../../../../cache/implementations/derivables/cache/_module.js"; import { type IReadableContext } from "../../../../execution-context/contracts/_module.js"; import { type ITimeSpan } from "../../../../time-span/contracts/_module.js"; /** * IMPORT_PATH: `"@daiso-tech/core/cache"` * @group Derivables */ export type CacheAdapters = Partial>>; /** * Configuration for `CacheResolver`. * Registers named cache adapters with optional schema validation and designates a default. * * IMPORT_PATH: `"@daiso-tech/core/cache"` * @group Derivables */ export type CacheResolverSettings = CacheSettingsBase & { /** * Named registry of cache adapters. Each key is an adapter alias and the corresponding value is the adapter instance. */ adapters: CacheAdapters; /** * The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map. */ defaultAdapter?: NoInfer; }; /** * The `CacheResolver` class is immutable. * * IMPORT_PATH: `"@daiso-tech/core/cache"` * @group Derivables */ export declare class CacheResolver implements ICacheResolver { private readonly settings; /** * @example * ```ts * import { CacheResolver } from "@daiso-tech/core/cache"; * import { MemoryCacheAdapter } from "@daiso-tech/core/cache/memory-cache-adapter"; * import { RedisCacheAdapter } from "@daiso-tech/core/cache/redis-cache-adapter"; * import { Serde } from "@daiso-tech/core/serde"; * import type { ISerde } from "@daiso-tech/core/serde/contracts"; * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"; * import Redis from "ioredis" * * const serde = new Serde(new SuperJsonSerdeAdapter()); * const cacheResolver = new CacheResolver({ * adapters: { * memory: new MemoryCacheAdapter(), * redis: new RedisCacheAdapter({ * database: new Redis("YOUR_REDIS_CONNECTION"), * serde, * }), * }, * defaultAdapter: "memory", * }); */ constructor(settings: CacheResolverSettings); setDefaultTtl(ttl: ITimeSpan | null): CacheResolver; setType(): CacheResolver; setExecutionContext(context: IReadableContext): CacheResolver; /** * @example * ```ts * import { CacheResolver } from "@daiso-tech/core/cache"; * import { MemoryCacheAdapter } from "@daiso-tech/core/cache/memory-cache-adapter"; * import { RedisCacheAdapter } from "@daiso-tech/core/cache/redis-cache-adapter"; * import { Serde } from "@daiso-tech/core/serde"; * import type { ISerde } from "@daiso-tech/core/serde/contracts"; * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"; * import { TimeSpan } from "@daiso-tech/core/time-span"; * import Redis from "ioredis" * * const serde = new Serde(new SuperJsonSerdeAdapter()); * const cacheResolver = new CacheResolver({ * adapters: { * memory: new MemoryCacheAdapter(), * redis: new RedisCacheAdapter({ * database: new Redis("YOUR_REDIS_CONNECTION"), * serde, * }), * }, * defaultAdapter: "memory", * }); * * // Will add key to cache using the default adapter which is MemoryCacheAdapter * await cacheResolver * .use() * .add("a", 1); * * // Will add key to cache using the redis adapter * await cacheResolver * .use("redis") * .add("a", 1); * * // You can change the default settings of the returned Cache instance. * await cacheResolver * .setDefaultTtl(TimeSpan.fromMinutes(2)) * .use("sqlite") * .add("a", 1); * ``` */ use(adapterName?: TAdapters | undefined): ICache; }