Class CacheFactory<TDrivers, TType>

Example

import { CacheFactory } from "@daiso-tech/core";
import Redis from "ioredis"

const cacheFactory = new CacheFactory({
  drivers: {
    memory: new MemoryCacheAdapter(),
    redis: new RedisCacheAdapter(new Redis()),
  },
  defaultDriver: "memory",
});

Type Parameters

TDrivers extends string = string
TType = unknown

Implements

ICacheFactory<TDrivers, TType>

Index

Constructors

constructor

Methods

use withType

Constructors

constructor

new CacheFactory<TDrivers, TType>(settings): CacheFactory<TDrivers, TType>
Type Parameters
- TDrivers extends string = string
- TType = unknown
Parameters
- settings: CacheFactorySettings<TDrivers>
Returns CacheFactory<TDrivers, TType>
- Defined in src/cache/implementations/derivables/cache-factory.ts:67

Methods

use

use(driverName?): IGroupableCache<TType>
The use method will throw an error if you provide it unregisted driver. If no default driver is defined an error will be thrown by use method.
Parameters
- driverName: undefined | TDrivers = ...
Returns IGroupableCache<TType>
Throws
UnregisteredDriverError

Throws
DefaultDriverNotDefinedError
Example
```
import { type ICacheFactory } from "@daiso-tech/core";

async function main(cacheFactory: ICacheFactory): Promise<void> {
  // Will add key using the default driver
  await cacheFactory
    .use()
    .add("a", 1);
  // Will add key using the redis addapter
  await cacheFactory
    .use("redis")
    .add("a", 1);
}
```
Implementation of ICacheFactory.use
- Defined in src/cache/implementations/derivables/cache-factory.ts:80

withType

withType<TOutput>(): ICacheFactory<TDrivers, TOutput>

The withTypes method is used to set the value types of the cache.

Type Parameters

TOutput = TType

Returns ICacheFactory<TDrivers, TOutput>

Example

import { type ICacheFactory } from "@daiso-tech/core";

async function main(cacheFactory: ICacheFactory): Promise<void> {
  await cacheFactory
    .withTypes<string>()
    .use()
    // You will se an typescript error
    .add("a", 1)
}

Class CacheFactory<TDrivers, TType>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CacheFactory<TDrivers, TType>

Methods

use

Parameters

Returns IGroupableCache<TType>

Throws

Throws

Example

withType

Type Parameters

Returns ICacheFactory<TDrivers, TOutput>

Example

Settings

On This Page