@sebspark/promise-cache 4.0.1 → 4.0.3

package/dist/index.d.mts

@@ -1,110 +1,9 @@
-import { createClient, RedisClientOptions, SetOptions } from 'redis';
+import { SetOptions, RedisClientOptions, createClient } from 'redis';
 export { RedisClientOptions } from 'redis';
-import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
+import { Logger } from 'winston';
 import { add, sub } from 'date-fns';
 
-type GetType<T> = {
-    value: T;
-    ttl?: number;
-    timestamp: number;
-};
-type SetParams<T> = {
-    value: T;
-    timestamp?: number;
-    ttl?: number;
-};
-type PersistorConstructorType = {
-    redis?: RedisClientOptions;
-    clientId?: UUID;
-    onError?: (error: string) => void;
-    onSuccess?: () => void;
-    logger?: Logger;
-};
-declare class Persistor {
-    client: ReturnType<typeof createClient> | null;
-    private readonly clientId?;
-    private readonly onError;
-    private readonly onSuccess;
-    private readonly logger;
-    private readonly redis?;
-    constructor({ redis, clientId, onSuccess, onError, logger, }: PersistorConstructorType);
-    startConnection(): Promise<void>;
-    size(): Promise<number>;
-    getClientId(): UUID | undefined;
-    getIsClientConnected(): boolean;
-    private createOptions;
-    /**
-     * Set a value in the cache.
-     * @param key Cache key.
-     * @param object.value Value to set in the cache.
-     * @param object.ttl Time to live in seconds.
-     * @param object.timestamp Timestamp
-     */
-    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
-    /**
-     * Get a value from the cache.
-     * @param key Cache key.
-     * @returns GetType<T> value
-     */
-    get<T>(key: string): Promise<GetType<T> | null>;
-    /**
-     * Delete a value from the cache.
-     * @param key Cache key
-     */
-    delete(key: string): Promise<void>;
-}
-
-type PromiseCacheOptions = {
-    ttlInSeconds?: number;
-    caseSensitive?: boolean;
-    redis?: RedisClientOptions;
-    fallbackToFunction?: boolean;
-    onError?: (error: string) => void;
-    onSuccess?: () => void;
-    logger?: Logger;
-};
-declare class PromiseCache<U> {
-    persistor: Persistor;
-    private readonly clientId;
-    private readonly caseSensitive;
-    private readonly fallbackToFunction;
-    private readonly ttl?;
-    private readonly logger;
-    /**
-     * Initialize a new PromiseCache.
-     * @param ttlInSeconds Default cache TTL.
-     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
-     */
-    constructor({ ttlInSeconds, caseSensitive, redis, fallbackToFunction, onSuccess, onError, logger, }: PromiseCacheOptions);
-    /**
-     * Cache size.
-     * @returns The number of entries in the cache.
-     */
-    size(): Promise<number>;
-    /**
-     * Override a value in the cache.
-     * @param key Cache key.
-     * @param value Cache value.
-     * @param ttlInSeconds Time to live in seconds.
-     */
-    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
-    /**
-     * Get a value from the cache.
-     * @param key Cache key.
-     */
-    find<U>(key: string): Promise<U | null>;
-    /**
-     * A simple promise cache wrapper.
-     * @param key Cache key.
-     * @param delegate The function to execute if the key is not in the cache.
-     * @param ttlInSeconds Time to live in seconds.
-     * @param ttlKeyInSeconds The key in the response object that contains the TTL.
-     * @returns The result of the delegate function.
-     */
-    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
-}
-
 type MultiExecReturnTypes = string[] | string | number | boolean | null | undefined;
 /**
  * Defines the expiration strategy for cached values.
@@ -854,6 +753,116 @@ declare class InMemoryPersistor implements IPersistor {
     private clearExpiration;
 }
 
+type GetType<T> = {
+    value: T;
+    ttl?: number;
+    timestamp: number;
+};
+type SetParams<T> = {
+    value: T;
+    timestamp?: number;
+    ttl?: number;
+};
+type PersistorConstructorType = {
+    redis?: RedisClientOptions;
+    clientId?: UUID;
+    onError?: (error: string) => void;
+    onSuccess?: () => void;
+    logger?: Logger;
+};
+declare class Persistor {
+    client: ReturnType<typeof createClient> | null;
+    private readonly clientId?;
+    private readonly onError;
+    private readonly onSuccess;
+    private readonly logger;
+    private readonly redis?;
+    constructor({ redis, clientId, onSuccess, onError, logger, }: PersistorConstructorType);
+    startConnection(): Promise<void>;
+    size(): Promise<number>;
+    getClientId(): UUID | undefined;
+    getIsClientConnected(): boolean;
+    private createOptions;
+    /**
+     * Set a value in the cache.
+     * @param key Cache key.
+     * @param object.value Value to set in the cache.
+     * @param object.ttl Time to live in seconds.
+     * @param object.timestamp Timestamp
+     */
+    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     * @returns GetType<T> value
+     */
+    get<T>(key: string): Promise<GetType<T> | null>;
+    /**
+     * Delete a value from the cache.
+     * @param key Cache key
+     */
+    delete(key: string): Promise<void>;
+}
+
+type PromiseCacheOptions = {
+    ttlInSeconds?: number;
+    caseSensitive?: boolean;
+    redis?: RedisClientOptions;
+    fallbackToFunction?: boolean;
+    onError?: (error: string) => void;
+    onSuccess?: () => void;
+    logger?: Logger;
+};
+declare class PromiseCache<U> {
+    persistor: Persistor;
+    private readonly clientId;
+    private readonly caseSensitive;
+    private readonly fallbackToFunction;
+    private readonly ttl?;
+    private readonly logger;
+    /**
+     * Initialize a new PromiseCache.
+     * @param ttlInSeconds Default cache TTL.
+     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+     */
+    constructor({ ttlInSeconds, caseSensitive, redis, fallbackToFunction, onSuccess, onError, logger, }: PromiseCacheOptions);
+    /**
+     * Cache size.
+     * @returns The number of entries in the cache.
+     */
+    size(): Promise<number>;
+    /**
+     * Override a value in the cache.
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttlInSeconds Time to live in seconds.
+     */
+    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     */
+    find<U>(key: string): Promise<U | null>;
+    /**
+     * A simple promise cache wrapper.
+     * @param key Cache key.
+     * @param delegate The function to execute if the key is not in the cache.
+     * @param ttlInSeconds Time to live in seconds.
+     * @param ttlKeyInSeconds The key in the response object that contains the TTL.
+     * @returns The result of the delegate function.
+     */
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
+}
+
+declare const serialize: <T>(data: T) => string;
+declare const deserialize: <T>(serialized: string | null) => T | null;
+
+declare const serializer_deserialize: typeof deserialize;
+declare const serializer_serialize: typeof serialize;
+declare namespace serializer {
+  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
+}
+
 declare const SECOND = 1000;
 declare const MINUTE: number;
 declare const HOUR: number;
@@ -885,13 +894,4 @@ declare namespace time {
   export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_sub as sub, time_today as today, time_tomorrow as tomorrow, time_weeks as weeks };
 }
 
-declare const serialize: <T>(data: T) => string;
-declare const deserialize: <T>(serialized: string | null) => T | null;
-
-declare const serializer_deserialize: typeof deserialize;
-declare const serializer_serialize: typeof serialize;
-declare namespace serializer {
-  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
-}
-
 export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, serializer, time };

package/dist/index.d.ts

@@ -1,110 +1,9 @@
-import { createClient, RedisClientOptions, SetOptions } from 'redis';
+import { SetOptions, RedisClientOptions, createClient } from 'redis';
 export { RedisClientOptions } from 'redis';
-import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
+import { Logger } from 'winston';
 import { add, sub } from 'date-fns';
 
-type GetType<T> = {
-    value: T;
-    ttl?: number;
-    timestamp: number;
-};
-type SetParams<T> = {
-    value: T;
-    timestamp?: number;
-    ttl?: number;
-};
-type PersistorConstructorType = {
-    redis?: RedisClientOptions;
-    clientId?: UUID;
-    onError?: (error: string) => void;
-    onSuccess?: () => void;
-    logger?: Logger;
-};
-declare class Persistor {
-    client: ReturnType<typeof createClient> | null;
-    private readonly clientId?;
-    private readonly onError;
-    private readonly onSuccess;
-    private readonly logger;
-    private readonly redis?;
-    constructor({ redis, clientId, onSuccess, onError, logger, }: PersistorConstructorType);
-    startConnection(): Promise<void>;
-    size(): Promise<number>;
-    getClientId(): UUID | undefined;
-    getIsClientConnected(): boolean;
-    private createOptions;
-    /**
-     * Set a value in the cache.
-     * @param key Cache key.
-     * @param object.value Value to set in the cache.
-     * @param object.ttl Time to live in seconds.
-     * @param object.timestamp Timestamp
-     */
-    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
-    /**
-     * Get a value from the cache.
-     * @param key Cache key.
-     * @returns GetType<T> value
-     */
-    get<T>(key: string): Promise<GetType<T> | null>;
-    /**
-     * Delete a value from the cache.
-     * @param key Cache key
-     */
-    delete(key: string): Promise<void>;
-}
-
-type PromiseCacheOptions = {
-    ttlInSeconds?: number;
-    caseSensitive?: boolean;
-    redis?: RedisClientOptions;
-    fallbackToFunction?: boolean;
-    onError?: (error: string) => void;
-    onSuccess?: () => void;
-    logger?: Logger;
-};
-declare class PromiseCache<U> {
-    persistor: Persistor;
-    private readonly clientId;
-    private readonly caseSensitive;
-    private readonly fallbackToFunction;
-    private readonly ttl?;
-    private readonly logger;
-    /**
-     * Initialize a new PromiseCache.
-     * @param ttlInSeconds Default cache TTL.
-     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
-     */
-    constructor({ ttlInSeconds, caseSensitive, redis, fallbackToFunction, onSuccess, onError, logger, }: PromiseCacheOptions);
-    /**
-     * Cache size.
-     * @returns The number of entries in the cache.
-     */
-    size(): Promise<number>;
-    /**
-     * Override a value in the cache.
-     * @param key Cache key.
-     * @param value Cache value.
-     * @param ttlInSeconds Time to live in seconds.
-     */
-    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
-    /**
-     * Get a value from the cache.
-     * @param key Cache key.
-     */
-    find<U>(key: string): Promise<U | null>;
-    /**
-     * A simple promise cache wrapper.
-     * @param key Cache key.
-     * @param delegate The function to execute if the key is not in the cache.
-     * @param ttlInSeconds Time to live in seconds.
-     * @param ttlKeyInSeconds The key in the response object that contains the TTL.
-     * @returns The result of the delegate function.
-     */
-    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
-}
-
 type MultiExecReturnTypes = string[] | string | number | boolean | null | undefined;
 /**
  * Defines the expiration strategy for cached values.
@@ -854,6 +753,116 @@ declare class InMemoryPersistor implements IPersistor {
     private clearExpiration;
 }
 
+type GetType<T> = {
+    value: T;
+    ttl?: number;
+    timestamp: number;
+};
+type SetParams<T> = {
+    value: T;
+    timestamp?: number;
+    ttl?: number;
+};
+type PersistorConstructorType = {
+    redis?: RedisClientOptions;
+    clientId?: UUID;
+    onError?: (error: string) => void;
+    onSuccess?: () => void;
+    logger?: Logger;
+};
+declare class Persistor {
+    client: ReturnType<typeof createClient> | null;
+    private readonly clientId?;
+    private readonly onError;
+    private readonly onSuccess;
+    private readonly logger;
+    private readonly redis?;
+    constructor({ redis, clientId, onSuccess, onError, logger, }: PersistorConstructorType);
+    startConnection(): Promise<void>;
+    size(): Promise<number>;
+    getClientId(): UUID | undefined;
+    getIsClientConnected(): boolean;
+    private createOptions;
+    /**
+     * Set a value in the cache.
+     * @param key Cache key.
+     * @param object.value Value to set in the cache.
+     * @param object.ttl Time to live in seconds.
+     * @param object.timestamp Timestamp
+     */
+    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     * @returns GetType<T> value
+     */
+    get<T>(key: string): Promise<GetType<T> | null>;
+    /**
+     * Delete a value from the cache.
+     * @param key Cache key
+     */
+    delete(key: string): Promise<void>;
+}
+
+type PromiseCacheOptions = {
+    ttlInSeconds?: number;
+    caseSensitive?: boolean;
+    redis?: RedisClientOptions;
+    fallbackToFunction?: boolean;
+    onError?: (error: string) => void;
+    onSuccess?: () => void;
+    logger?: Logger;
+};
+declare class PromiseCache<U> {
+    persistor: Persistor;
+    private readonly clientId;
+    private readonly caseSensitive;
+    private readonly fallbackToFunction;
+    private readonly ttl?;
+    private readonly logger;
+    /**
+     * Initialize a new PromiseCache.
+     * @param ttlInSeconds Default cache TTL.
+     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+     */
+    constructor({ ttlInSeconds, caseSensitive, redis, fallbackToFunction, onSuccess, onError, logger, }: PromiseCacheOptions);
+    /**
+     * Cache size.
+     * @returns The number of entries in the cache.
+     */
+    size(): Promise<number>;
+    /**
+     * Override a value in the cache.
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttlInSeconds Time to live in seconds.
+     */
+    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     */
+    find<U>(key: string): Promise<U | null>;
+    /**
+     * A simple promise cache wrapper.
+     * @param key Cache key.
+     * @param delegate The function to execute if the key is not in the cache.
+     * @param ttlInSeconds Time to live in seconds.
+     * @param ttlKeyInSeconds The key in the response object that contains the TTL.
+     * @returns The result of the delegate function.
+     */
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
+}
+
+declare const serialize: <T>(data: T) => string;
+declare const deserialize: <T>(serialized: string | null) => T | null;
+
+declare const serializer_deserialize: typeof deserialize;
+declare const serializer_serialize: typeof serialize;
+declare namespace serializer {
+  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
+}
+
 declare const SECOND = 1000;
 declare const MINUTE: number;
 declare const HOUR: number;
@@ -885,13 +894,4 @@ declare namespace time {
   export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_sub as sub, time_today as today, time_tomorrow as tomorrow, time_weeks as weeks };
 }
 
-declare const serialize: <T>(data: T) => string;
-declare const deserialize: <T>(serialized: string | null) => T | null;
-
-declare const serializer_deserialize: typeof deserialize;
-declare const serializer_serialize: typeof serialize;
-declare namespace serializer {
-  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
-}
-
 export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, serializer, time };