moleculer/src/cachers/base.d.ts

Fast & powerful microservices framework for Node.JS

import type Context = require("../context");
import type { Logger } from "../logger-factory";
import type ServiceBroker = require("../service-broker");
import type Service = require("../service");

declare namespace Cacher {
	export type CacherKeygen<TParams = unknown, TMeta extends object = object> = (
		action: Service.ActionSchema,
		opts: Service.ActionCacheOptions<TParams, TMeta>,
		ctx: Context<TParams, TMeta>
	) => string;

	export interface CacherOptions {
		ttl?: number;
		keygen?: CacherKeygen;
		maxParamsLength?: number;
		missingResponse?: any;
		prefix?: string;

		lock?: boolean | {
			enabled?: boolean;
			staleTime?: number;
			ttl?: number;
		}
	}
}

declare abstract class Cacher<TOptions extends Cacher.CacherOptions> {
	opts: TOptions;

	connected: boolean | null;
	broker: ServiceBroker;
	metrics: any;
	logger: Logger;
	prefix?: string;

	constructor(opts?: TOptions);

	init(broker: ServiceBroker): void;

	abstract close(): Promise<void>;

	abstract get(key: string): Promise<Record<string, unknown> | null>;

	abstract getWithTTL(key: string): Promise<Record<string, unknown> | null>;

	abstract set(key: string, data: any, ttl?: number): Promise<void>;

	abstract del(key: string | string[]): Promise<void>;

	abstract clean(match?: string | string[]): Promise<void>;

	getCacheKey(action: string, opts: object, ctx: Context): string;

	defaultKeygen(action: string, opts: object, ctx: Context): string;

	middleware();

	middlewareWithLock(ctx: Context, cacheKey: string, handler: Function, opts: any): Promise<any>;

	middlewareWithoutLock(
		ctx: Context,
		cacheKey: string,
		handler: Function,
		opts: any
	): Promise<any>;

	getCacheKeys(): Promise<Array<any>>;

	abstract tryLock(key: string | string[], ttl?: number): Promise<() => Promise<void>>;

	abstract lock(key: string | string[], ttl?: number): Promise<() => Promise<void>>;
}

export = Cacher;