PlatformCache

@tsed/platform-cache

Usage

import { PlatformCache } from "@tsed/platform-cache";

See /packages/platform/platform-cache/src/types/services/PlatformCache.ts.

Overview

class PlatformCache {
    protected settings: Configuration;
    protected injector: InjectorService;
    protected logger: Logger;
    get cache(): CacheManager | undefined;
    $onInit(): Promise<void>;
    getKeysOf(target: Type<any>, propertyKey: string | symbol): Promise<string[]>;
    disabled(): boolean;
    defaultKeyResolver(): (args: any[], ctx?: any) => string;
    defaultTtl(): Ttl;
    calculateTTL(result?: any, currentTtl?: Ttl): number;
    ttl(key: string): Promise<void> | Promise<number>;
    wrap<T>(key: string, fetch: () => Promise<T>, ttl?: number): Promise<T>;
    get<T>(key: string, options?: JsonDeserializerOptions): Promise<T | undefined>;
    set<T>(key: string, value: any, options?: CachingConfig<T>): Promise<T | undefined>;
    getCachedObject(key: string): Promise<PlatformCachedObject | undefined>;
    setCachedObject(key: string, data: any, opts: {
        ttl: number;
    } & Record<string, any>): Promise<void>;
    del(key: string): Promise<void>;
    reset(): Promise<void>;
    keys(...args: any[]): Promise<string[]>;
    deleteKeys(patterns: string): Promise<string[]>;
    getMatchingKeys(patterns: string): Promise<string[]>;
    deleteMatchingKeys(patterns: string): Promise<string[]>;
    refresh(callback: () => Promise<any> | any): any;
    isForceRefresh(): boolean;
    protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache | import("cache-manager").MemoryCache>;
}

protected settings

protected settings: Configuration;

protected injector

protected injector: InjectorService;

protected logger

protected logger: Logger;

get cache

get cache(): CacheManager | undefined;

$onInit

$onInit(): Promise<void>;

getKeysOf

getKeysOf(target: Type<any>, propertyKey: string | symbol): Promise<string[]>;

disabled

disabled(): boolean;

defaultKeyResolver

defaultKeyResolver(): (args: any[], ctx?: any) => string;

defaultTtl

defaultTtl(): Ttl;

calculateTTL

calculateTTL(result?: any, currentTtl?: Ttl): number;

ttl

ttl(key: string): Promise<void> | Promise<number>;

wrap

wrap<T>(key: string, fetch: () => Promise<T>, ttl?: number): Promise<T>;

get

get<T>(key: string, options?: JsonDeserializerOptions): Promise<T | undefined>;

set

set<T>(key: string, value: any, options?: CachingConfig<T>): Promise<T | undefined>;

getCachedObject

getCachedObject(key: string): Promise<PlatformCachedObject | undefined>;

setCachedObject

setCachedObject(key: string, data: any, opts: {
     ttl: number;
 } & Record<string, any>): Promise<void>;

del

del(key: string): Promise<void>;

reset

reset(): Promise<void>;

keys

keys(...args: any[]): Promise<string[]>;

deleteKeys

deleteKeys(patterns: string): Promise<string[]>;

getMatchingKeys

getMatchingKeys(patterns: string): Promise<string[]>;

Use micromatch instead native patterns. Use this method if the native store method doesn't support glob patterns

deleteMatchingKeys

deleteMatchingKeys(patterns: string): Promise<string[]>;

refresh

refresh(callback: () => Promise<any> | any): any;

isForceRefresh

isForceRefresh(): boolean;

protected createCacheManager

protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache | import("cache-manager").MemoryCache>;