Type Alias ICacheFactory<TDrivers, TType>

Type declaration

• use:function

  • 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

    • OptionaldriverName: 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);
    }
    Copy

• withType:function

  • 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)
    }
    Copy