Iskra API Reference
    Preparing search index...

    Interface KVAdapter

    interface KVAdapter {
        id: string;
        clear?(prefix?: string): Promise<void>;
        connect(): void | Promise<void>;
        del(key: string): Promise<void>;
        disconnect(): void | Promise<void>;
        get<T = unknown>(key: string): Promise<T | undefined>;
        has(key: string): Promise<boolean>;
        mdel?(keys: string[]): Promise<void>;
        mget?<T = unknown>(keys: string[]): Promise<(T | undefined)[]>;
        mset?<T = unknown>(entries: [string, T][], ttl?: number): Promise<void>;
        sadd?(key: string, member: string, ttl?: number): Promise<void>;
        sdrain?(key: string): Promise<string[]>;
        set<T = unknown>(key: string, value: T, ttl?: number): Promise<void>;
    }

    Implemented by

    Index
    id
    clear? connect del disconnect get has mdel? mget? mset? sadd? sdrain? set
    id: string

    • Deletes every key that starts with prefix (every key the adapter holds without one), without touching the connection. An adapter that cannot leaves it out, and callers such as cache-kit's clear() then fail.

      Parameters

      • Optionalprefix: string

      Returns Promise<void>

    • Returns void | Promise<void>

    • Parameters

      • key: string

      Returns Promise<void>

    • Returns void | Promise<void>

    • Type Parameters

      • T = unknown

      Parameters

      • key: string

      Returns Promise<T | undefined>

    • Parameters

      • key: string

      Returns Promise<boolean>

    • Parameters

      • keys: string[]

      Returns Promise<void>

    • Type Parameters

      • T = unknown

      Parameters

      • keys: string[]

      Returns Promise<(T | undefined)[]>

    • Type Parameters

      • T = unknown

      Parameters

      • entries: [string, T][]
      • Optionalttl: number

      Returns Promise<void>

    • Expiring sets, for cache-kit's tag index: sadd adds member to the set at key for ttl seconds (for good without one), and the set lives as long as its longest-lived member. sdrain deletes the set and returns its unexpired members in one step, so a member added meanwhile is never lost.

      Parameters

      • key: string
      • member: string
      • Optionalttl: number

      Returns Promise<void>

    • Parameters

      • key: string

      Returns Promise<string[]>

    • Type Parameters

      • T = unknown

      Parameters

      • key: string
      • value: T
      • Optionalttl: number

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods