@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.
135 lines • 4.54 kB
JavaScript
/**
* @module Cache
*/
import {} from "@standard-schema/spec";
import {} from "../../../../cache/contracts/_module.js";
import { Cache, DEFAULT_CACHE_NAMESPACE, } from "../../../../cache/implementations/derivables/cache/_module.js";
import {} from "../../../../event-bus/contracts/_module.js";
import {} from "../../../../namespace/_module.js";
import {} from "../../../../time-span/contracts/_module.js";
import { DefaultAdapterNotDefinedError, UnregisteredAdapterError, } from "../../../../utilities/_module.js";
/**
* The `CacheFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/cache"`
* @group Derivables
*/
export class CacheFactory {
settings;
/**
* @example
* ```ts
* import { CacheFactory } 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 cacheFactory = new CacheFactory({
* adapters: {
* memory: new MemoryCacheAdapter(),
* redis: new RedisCacheAdapter({
* database: new Redis("YOUR_REDIS_CONNECTION"),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
*/
constructor(settings) {
this.settings = settings;
}
setNamespace(namespace) {
return new CacheFactory({
...this.settings,
namespace,
});
}
setDefaultTtl(ttl) {
return new CacheFactory({
...this.settings,
defaultTtl: ttl,
});
}
setEventBus(eventBus) {
return new CacheFactory({
...this.settings,
eventBus,
});
}
setSchema(schema) {
return new CacheFactory({
...this.settings,
schema,
});
}
setType() {
return new CacheFactory(this.settings);
}
setJitter(jitter) {
return new CacheFactory({
...this.settings,
defaultJitter: jitter,
});
}
/**
* @example
* ```ts
* import { CacheFactory } 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" from "@daiso-tech/core/time-span";
* import Redis from "ioredis"
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const cacheFactory = new CacheFactory({
* 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 cacheFactory
* .use()
* .add("a", 1);
*
* // Will add key to cache using the redis adapter
* await cacheFactory
* .use("redis")
* .add("a", 1);
*
* // You can change the default settings of the returned Cache instance.
* await cacheFactory
* .setDefaultTtl(TimeSpan.fromMinutes(2))
* .use("sqlite")
* .add("a", 1);
* ```
*/
use(adapterName = this.settings.defaultAdapter) {
if (adapterName === undefined) {
throw new DefaultAdapterNotDefinedError(CacheFactory.name);
}
const adapter = this.settings.adapters[adapterName];
if (adapter === undefined) {
throw new UnregisteredAdapterError(adapterName);
}
const { namespace = DEFAULT_CACHE_NAMESPACE } = this.settings;
return new Cache({
...this.settings,
adapter,
namespace: namespace.appendRoot(adapterName),
});
}
}
//# sourceMappingURL=cache-factory.js.map