PlatformCacheInterceptor

@tsed/platform-cache

Usage

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

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

Overview

class PlatformCacheInterceptor implements InterceptorMethods {
    protected cache: PlatformCache;
    protected logger: Logger;
    protected prefix: string;
    protected blacklist: string[];
    intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): unknown;
    canRefreshInBackground(key: string, { refreshThreshold, ttl }: {
        refreshThreshold?: number;
        ttl: any;
    }, next: Function): Promise<void>;
    cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
    cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
    protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): any;
    protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>): {
        key: string;
        refreshThreshold: number | undefined;
        ttl: import("../services/PlatformCache.js").Ttl | undefined;
        type: any;
        args: any;
        collectionType: any;
        keyArgs: string;
        canCache: ((item: any) => boolean) | undefined;
        $ctx: any;
    };
    protected hasKeyInQueue(key: string): Promise<boolean>;
    protected addKeyToQueue(key: string): Promise<void>;
    protected deleteKeyFromQueue(key: string): Promise<void>;
    protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext): any;
}

protected cache

protected cache: PlatformCache;

protected logger

protected logger: Logger;

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 }: {
     refreshThreshold?: number;
     ttl: any;
 }, next: Function): Promise<void>;

cacheMethod

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

cacheResponse

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

protected getArgs

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

protected getOptions

protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>): {
     key: string;
     refreshThreshold: number | undefined;
     ttl: import("../services/PlatformCache.js").Ttl | undefined;
     type: any;
     args: any;
     collectionType: any;
     keyArgs: string;
     canCache: ((item: any) => boolean) | undefined;
     $ctx: any;
 };

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 sendResponse

protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext): any;