mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
1c9bb251d1
* fix: update typings for newest cache-manager version fix: update typings for newest cache-manager version * update StoreConfig
78 lines
3.2 KiB
TypeScript
78 lines
3.2 KiB
TypeScript
// Type definitions for cache-manager v2.10.0
|
|
// Project: https://github.com/BryanDonovan/node-cache-manager
|
|
// Definitions by: Simon Gausmann <https://github.com/GausSim>
|
|
// Dominik Einkemmer <https://github.com/dominikeinkemmer>
|
|
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
|
// TypeScript Version: 2.8
|
|
|
|
export interface CachingConfig {
|
|
ttl: number | TtlFunction;
|
|
}
|
|
|
|
export interface TtlFunction {
|
|
(result: any): number;
|
|
}
|
|
|
|
export interface Store {
|
|
// These functions will just be bound to the Cache object if they exist so args can be anything
|
|
get<T>(...args: any[]): Promise<any>;
|
|
set<T>(...args: any[]): Promise<any>;
|
|
|
|
mget?<T>(...args: any[]): Promise<any>;
|
|
mset?<T>(...args: any[]): Promise<any>;
|
|
del?<T>(...args: any[]): Promise<any>;
|
|
setex?<T>(...args: any[]): Promise<any>;
|
|
reset?<T>(...args: any[]): Promise<any>;
|
|
keys?<T>(...args: any[]): Promise<any>;
|
|
ttl?<T>(...args: any[]): Promise<any>;
|
|
}
|
|
|
|
export interface StoreConfig extends CachingConfig {
|
|
store: 'memory' | 'none' | Store | {
|
|
create(...args: any[]): Store;
|
|
};
|
|
max?: number;
|
|
|
|
/**
|
|
* You may pass in any other arguments these will be passed on to the `create` method of your store,
|
|
* otherwise they will be ignored.
|
|
*/
|
|
[key: string]: any;
|
|
}
|
|
|
|
export interface CacheOptions {
|
|
/**
|
|
* Promise library to replace global.Promise
|
|
*/
|
|
promiseDependency?: any;
|
|
isCacheableValue?(value: any): boolean;
|
|
}
|
|
|
|
export type CallbackFunc<T> = (error: any, result: T) => void;
|
|
export type WrapArgsType<T> = string | ((callback: CallbackFunc<T>) => void) | CachingConfig | CallbackFunc<T>;
|
|
|
|
export interface Cache {
|
|
set<T>(key: string, value: T, options: CachingConfig, callback?: (error: any) => void): void;
|
|
set<T>(key: string, value: T, ttl: number, callback?: (error: any) => void): void;
|
|
set<T>(key: string, value: T, options: CachingConfig): Promise<any>;
|
|
set<T>(key: string, value: T, ttl: number): Promise<any>;
|
|
|
|
// Because the library accepts multiple keys as arguments but not as an array and rather as individual parameters
|
|
// of the function, the type definition had to be changed to this rather than specific ones
|
|
// actual definitions would looks like this (impossible in typescript):
|
|
// wrap<T>(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig, callback: (error: any, result: T) => void): void
|
|
// wrap<T>(...keys: string[], work: (callback: (error: any, result: T) => void) => void, callback: (error: any, result: T) => void): void
|
|
// wrap<T>(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig): void
|
|
// wrap<T>(...keys: string[], work: (callback: (error: any, result: T) => void) => void): Promise<any>;
|
|
wrap<T>(...args: WrapArgsType<T>[]): Promise<any>;
|
|
|
|
get<T>(key: string, callback: (error: any, result: T) => void): void;
|
|
get<T>(key: string): Promise<any>;
|
|
|
|
del(key: string, callback: (error: any) => void): void;
|
|
del(key: string): Promise<any>;
|
|
}
|
|
|
|
export function caching(IConfig: StoreConfig & CacheOptions): Cache;
|
|
export function multiCaching(Caches: Cache[], options?: CacheOptions): Cache;
|