PlatformCache

@tsed/platform-cache

Usage

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

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

Overview

class PlatformCache {
    get cache(): CacheManager | undefined;
    $onInit(): Promise<void>;
    getKeysOf(target: Type<any>, propertyKey: string | symbol): Promise<string[]>;
    cachePrefix(): string;
    buildNamespace(target: Type<any>, propertyKey: string | symbol): (string | symbol)[];
    buildEntryKey(target: Type<any>, propertyKey: string | symbol, keyArgs: string): string;
    buildEntryPattern(target: Type<any>, propertyKey: string | symbol, suffix?: string): string;
    buildInternalKey(namespace: "queue" | "refresh-cooldown", key: string): string;
    disabled(): boolean;
    defaultKeyResolver(): (args: any[], ctx?: any) => string;
    defaultTtl(): Ttl | undefined;
    calculateTTL(result?: any, currentTtl?: Ttl): number | undefined;
    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>;
}

get cache

get cache(): CacheManager | undefined;

$onInit

$onInit(): Promise<void>;

getKeysOf

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

cachePrefix

cachePrefix(): string;

Returns the global cache key prefix from settings (cache.prefix).

buildNamespace

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

Builds the stable namespace segments used by cached entries for a method. The namespace combines the global cache prefix (if configured) and the method prefix.

buildEntryKey

buildEntryKey(target: Type<any>, propertyKey: string | symbol, keyArgs: string): string;

Builds the final cache key for a method call.

buildEntryPattern

buildEntryPattern(target: Type<any>, propertyKey: string | symbol, suffix?: string): string;

Builds a key pattern scoped to a cached method namespace. Useful for listing/invalidation of keys produced by the same cached method.

buildInternalKey

buildInternalKey(namespace: "queue" | "refresh-cooldown", key: string): string;

Builds internal keys used by cache housekeeping features (refresh queue and refresh cooldown markers).

disabled

disabled(): boolean;

defaultKeyResolver

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

defaultTtl

defaultTtl(): Ttl | undefined;

calculateTTL

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

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>;