timed-kvs/types/timed-kvs.d.ts

Lightweight Key-value storage with built-in TTL expiration management

/**
 * timed-kvs.d.ts
 */

export namespace TKVS {

    interface Envelope<T> {
        value: T;
    }

    interface Options {
        // TTL in milliseconds
        expires?: number;

        // maximum number of items stored in the storage
        maxItems?: number;
    }
}

export class TimedKVS<T> {
    constructor(options?: TKVS.Options);

    get(key: string): T;

    getItem(key: string): TKVS.Envelope<T>;

    set(key: string, value: T): void;

    setItem(key: string, value: TKVS.Envelope<T>): void;

    delete(key: string): void;

    keys(): string[];

    values(): T[];
}