Class EncoderBackedStore<K, V, SerializedType>

constructor

• new EncoderBackedStore<K, V, SerializedType>(fields): EncoderBackedStore<K, V, SerializedType>

• Type Parameters

  • K

  • V

  • SerializedType = any

  Parameters

  • fields: {
        keyEncoder: ((key) => string);
        store: BaseStore<string, SerializedType>;
        valueDeserializer: ((value) => V);
        valueSerializer: ((value) => SerializedType);
    }

    • keyEncoder: ((key) => string)

      • • (key): string

        • Parameters

          • key: K

          Returns string

    • store: BaseStore<string, SerializedType>

    • valueDeserializer: ((value) => V)

      • • (value): V

        • Parameters

          • value: SerializedType

          Returns V

    • valueSerializer: ((value) => SerializedType)

      • • (value): SerializedType

        • Parameters

          • value: V

          Returns SerializedType

  Returns EncoderBackedStore<K, V, SerializedType>

keyEncoder

store

valueDeserializer

valueSerializer

mdelete

• mdelete(keys): Promise<void>

• Method to delete multiple keys at once. It works with the encoded keys.

  Parameters

  • keys: K[]

    Array of keys to delete

  Returns Promise<void>

  Promise that resolves when the operation is complete

mget

• mget(keys): Promise<(undefined | V)[]>

• Method to get multiple keys at once. It works with the encoded keys and serialized values.

  Parameters

  • keys: K[]

    Array of keys to get

  Returns Promise<(undefined | V)[]>

  Promise that resolves with an array of values or undefined for each key

mset

• mset(keyValuePairs): Promise<void>

• Method to set multiple keys at once. It works with the encoded keys and serialized values.

  Parameters

  • keyValuePairs: [K, V][]

    Array of key-value pairs to set

  Returns Promise<void>

  Promise that resolves when the operation is complete

yieldKeys

• yieldKeys(prefix?): AsyncGenerator<string | K, any, unknown>

• Method to yield keys. It works with the encoded keys.

  Parameters

  • Optional prefix: string

    Optional prefix to filter keys

  Returns AsyncGenerator<string | K, any, unknown>

  AsyncGenerator that yields keys