Class TransformedMap<K, V, TK, TV, M>

constructor

• new TransformedMap<K, V, TK, TV, M>(map, keyCodec?, valueCodec?): TransformedMap<K, V, TK, TV, M>

• Type Parameters

  • K

  • V

  • TK = K

  • TV = V

  • M extends MaybeAsyncMap<TK, TV> & Partial<MaybeAsyncMapBatch<TK, TV> & Iterable<[TK, TV]> & AsyncIterable<[TK, TV]> & RangeQueryable<TK, TV>> = MaybeAsyncMap<TK, TV> & Partial<MaybeAsyncMapBatch<TK, TV> & Iterable<[TK, TV]> & AsyncIterable<[TK, TV]> & RangeQueryable<TK, TV>>

  Parameters

  • map: M

    Underlying map.

  • keyCodec: Codec<K, TK> = ...

    Key codec.

  • valueCodec: Codec<V, TV> = ...

    Value codec.

  Returns TransformedMap<K, V, TK, TV, M>

[asyncIterator]

[iterator]

Readonly [rangeQueryable]

entries

keys

Readonly map

values

[toStringTag]

• get [toStringTag](): string

• Returns string

delete

• delete(key, options?): unknown

• Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.

  Parameters

  • key: K

  • Optional options: AbortOptions

  Returns unknown

deleteMany

• deleteMany(keys, options?): AsyncIterableIterator<undefined | Error>

• Deletes the values with given keys.

  Parameters

  • keys: Iterable<K>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | Error>

get

• get(key, options?): MaybePromise<undefined | V>

• Gets a value by key from the map.

  Parameters

  • key: K

  • Optional options: AbortOptions

  Returns MaybePromise<undefined | V>

getMany

• getMany(keys, options?): AsyncIterableIterator<undefined | V>

• Gets the list of data identified by given keys.

  Parameters

  • keys: Iterable<K>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | V>

has

• has(key, options?): MaybePromise<boolean>

• Returns whether a key exists in the map.

  Parameters

  • key: K

  • Optional options: AbortOptions

  Returns MaybePromise<boolean>

hasMany

• hasMany(keys, options?): AsyncIterableIterator<boolean>

• Checks if given keys exist in the set.

  Parameters

  • keys: Iterable<K>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<boolean>

set

• set(key, value, options?): unknown

• Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.

  Parameters

  • key: K

  • value: V

  • Optional options: AbortOptions

  Returns unknown

setMany

• setMany(entries, options?): AsyncIterableIterator<undefined | Error>

• Sets given list of entries.

  Parameters

  • entries: Iterable<[K, V]>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | Error>

updateMany

• updateMany(entries, options?): AsyncIterableIterator<undefined | Error>

• Sets or deletes given list of entries.

  Parameters

  • entries: Iterable<[K, V?]>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | Error>