@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
119 lines (118 loc) • 5.2 kB
TypeScript
/**
* @module Cache
*/
import { type StandardSchemaV1 } from "@standard-schema/spec";
import { type CacheAdapterVariants, type ICache, type ICacheResolver } from "../../../../cache/contracts/_module.js";
import { type CacheSettingsBase } from "../../../../cache/implementations/derivables/cache/_module.js";
import { type EventBusInput } from "../../../../event-bus/contracts/_module.js";
import { type IExecutionContext } from "../../../../execution-context/contracts/_module.js";
import { type LockFactoryInput } from "../../../../lock/contracts/_module.js";
import { type INamespace } from "../../../../namespace/contracts/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type WaitUntil } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/cache"`
* @group Derivables
*/
export type CacheAdapters<TAdapters extends string = string> = Partial<Record<TAdapters, CacheAdapterVariants<any>>>;
/**
* 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<TAdapters extends string = string, TType = unknown> = CacheSettingsBase<TType> & {
/**
* Named registry of cache adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
*/
adapters: CacheAdapters<TAdapters>;
/**
* The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map.
*/
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `CacheResolver` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/cache"`
* @group Derivables
*/
export declare class CacheResolver<TAdapters extends string = string, TType = unknown> implements ICacheResolver<TAdapters, TType> {
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<TAdapters, TType>);
setNamespace(namespace: INamespace): CacheResolver<TAdapters, TType>;
setDefaultTtl(ttl: ITimeSpan | null): CacheResolver<TAdapters, TType>;
setEventBus(eventBus: EventBusInput): CacheResolver<TAdapters, TType>;
setSchema<TSchemaOutputType>(schema: StandardSchemaV1<TSchemaOutputType>): CacheResolver<TAdapters, TSchemaOutputType>;
setType<TOutputType>(): CacheResolver<TAdapters, TOutputType>;
setJitter(jitter: number): CacheResolver<TAdapters, TType>;
setWaitUntil(waitUntil: WaitUntil): CacheResolver<TAdapters, TType>;
setExecutionContext(executionContext: IExecutionContext): CacheResolver<TAdapters, TType>;
setLockFactory(lockFactory: LockFactoryInput): CacheResolver<TAdapters, TType>;
/**
* @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<TType>;
}