renovate/dist/util/cache/package/decorator.d.ts

Automated dependency updates. Flexible so you don't need to be.

import type { Decorator } from '../../decorator';
import type { PackageCacheNamespace } from './types';
type HashFunction<T extends any[] = any[]> = (...args: T) => string;
type NamespaceFunction<T extends any[] = any[]> = (...args: T) => PackageCacheNamespace;
type BooleanFunction<T extends any[] = any[]> = (...args: T) => boolean;
/**
 * The cache decorator parameters.
 */
interface CacheParameters {
    /**
     * The cache namespace
     * Either a string or a hash function that generates a string
     */
    namespace: PackageCacheNamespace | NamespaceFunction;
    /**
     * The cache key
     * Either a string or a hash function that generates a string
     */
    key: string | HashFunction;
    /**
     * A function that returns true if a result is cacheable
     * Used to prevent caching of private, sensitive, results
     */
    cacheable?: BooleanFunction;
    /**
     * The TTL (or expiry) of the key in minutes
     */
    ttlMinutes?: number;
}
/**
 * caches the result of a decorated method.
 */
export declare function cache<T>({ namespace, key, cacheable, ttlMinutes, }: CacheParameters): Decorator<T>;
export {};