Installation

npm install --save @types/stale-lru-cache

Summary

This package contains type definitions for stale-lru-cache (https://github.com/cyberthom/stale-lru-cache).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stale-lru-cache.

index.d.ts

1declare class Cache<K, V> {
2    constructor(options?: Cache.CacheOptions<K, V>);
3    delete(key: K): boolean;
4    get(key: K): V | undefined;
5    set(key: K, value: V, options?: string | Cache.SetOptions<K, V>): boolean;
6    has(key: K): boolean;
7    isStale(key: K): boolean;
8    keys(): K[];
9    reset(): void;
10    size(): number;
11    values(): V[];
12    wrap(
13        key: K,
14        revalidate: Cache.RevalidationCallback<K, V>,
15        callback: Cache.OptionsCallback<K, V>,
16    ): void;
17}
18
19declare namespace Cache {
20    type OptionsCallback<K, V> = (error: any, value?: V, options?: string | SetOptions<K, V>) => void;
21    type RevalidationCallback<K, V> = (key: K, callback: OptionsCallback<K, V>) => void;
22
23    interface CacheOptions<K, V> {
24        maxAge?: number | undefined;
25        staleWhileRevalidate?: number | undefined;
26        revalidate?: RevalidationCallback<K, V> | undefined;
27        maxSize?: number | undefined;
28        getSize?(value: V, key: K): number;
29    }
30
31    interface SetOptions<K, V> {
32        maxAge?: number | undefined;
33        staleWhileRevalidate?: number | undefined;
34        revalidate?: RevalidationCallback<K, V> | undefined;
35    }
36}
37
38export = Cache;
39

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Joona Heikkilä.