PlatformCacheInterceptor

@tsed/platform-cache

Usage

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

See /packages/platform/platform-cache/src/interceptors/PlatformCacheInterceptor.ts.

Overview

class PlatformCacheInterceptor implements InterceptorMethods {
    protected cache: PlatformCache;
    protected prefix: string;
    protected blacklist: string[];
    intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): unknown;
    canRefreshInBackground(key: string, { refreshThreshold, ttl, cachedTTL }: {
        refreshThreshold?: number;
        ttl: any;
        cachedTTL?: number;
    }, next: Function, $ctx?: Context): Promise<void>;
    cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
    cacheResponse(interceptorContext: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
    protected getMethod($ctx?: Context): string | undefined;
    protected noCache($ctx?: Context): boolean;
    protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): unknown[];
    protected getOptions(interceptorContext: InterceptorContext<any, PlatformCacheOptions>, defaultByPass?: PlatformCacheOptions["byPass"]): {
        key: string;
        refreshThreshold: number | undefined;
        ttl: import("../services/PlatformCache.js").Ttl | undefined;
        type: any;
        args: unknown[];
        collectionType: any;
        keyArgs: string;
        canCache: ((item: any) => boolean) | undefined;
        $ctx: Context;
        byPass: false | "no-cache" | ((args: any[], $ctx?: BaseContext) => boolean);
    };
    protected getContextFromArgs(args: unknown[]): Context | undefined;
    protected shouldByPassCache(byPass: PlatformCacheOptions["byPass"], args: unknown[], $ctx?: Context): boolean;
    protected hasKeyInQueue(key: string): Promise<boolean>;
    protected addKeyToQueue(key: string): Promise<void>;
    protected deleteKeyFromQueue(key: string): Promise<void>;
    protected acquireRefreshLock(key: string): Promise<() => void>;
    protected getRefreshCooldownKey(key: string): string;
    protected getRefreshThresholdWithJitter(key: string, refreshThreshold: number): number;
    protected hasRefreshCooldown(key: string): Promise<boolean>;
    protected addRefreshCooldown(key: string, refreshThreshold: number): Promise<void>;
    protected sendResponse(cachedObject: PlatformCachedObject): any;
}

protected cache

protected cache: PlatformCache;

protected prefix

protected prefix: string;

protected blacklist

protected blacklist: string[];

intercept

intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): unknown;

canRefreshInBackground

canRefreshInBackground(key: string, { refreshThreshold, ttl, cachedTTL }: {
     refreshThreshold?: number;
     ttl: any;
     cachedTTL?: number;
 }, next: Function, $ctx?: Context): Promise<void>;

cacheMethod

cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;

cacheResponse

cacheResponse(interceptorContext: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;

protected getMethod

protected getMethod($ctx?: Context): string | undefined;

protected noCache

protected noCache($ctx?: Context): boolean;

protected getArgs

protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): unknown[];

protected getOptions

protected getOptions(interceptorContext: InterceptorContext<any, PlatformCacheOptions>, defaultByPass?: PlatformCacheOptions["byPass"]): {
     key: string;
     refreshThreshold: number | undefined;
     ttl: import("../services/PlatformCache.js").Ttl | undefined;
     type: any;
     args: unknown[];
     collectionType: any;
     keyArgs: string;
     canCache: ((item: any) => boolean) | undefined;
     $ctx: Context;
     byPass: false | "no-cache" | ((args: any[], $ctx?: BaseContext) => boolean);
 };

protected getContextFromArgs

protected getContextFromArgs(args: unknown[]): Context | undefined;

protected shouldByPassCache

protected shouldByPassCache(byPass: PlatformCacheOptions["byPass"], args: unknown[], $ctx?: Context): boolean;

protected hasKeyInQueue

protected hasKeyInQueue(key: string): Promise<boolean>;

protected addKeyToQueue

protected addKeyToQueue(key: string): Promise<void>;

protected deleteKeyFromQueue

protected deleteKeyFromQueue(key: string): Promise<void>;

protected acquireRefreshLock

protected acquireRefreshLock(key: string): Promise<() => void>;

protected getRefreshCooldownKey

protected getRefreshCooldownKey(key: string): string;

protected getRefreshThresholdWithJitter

protected getRefreshThresholdWithJitter(key: string, refreshThreshold: number): number;

protected hasRefreshCooldown

protected hasRefreshCooldown(key: string): Promise<boolean>;

protected addRefreshCooldown

protected addRefreshCooldown(key: string, refreshThreshold: number): Promise<void>;

protected sendResponse

protected sendResponse(cachedObject: PlatformCachedObject): any;