Class MapSet<K, MK, MV, M>

constructor

• new MapSet<K, MK, MV, M>(map, codec?): MapSet<K, MK, MV, M>

• Type Parameters

  • K

  • MK = K

  • MV = K

  • M extends MapSetBackingMap<MK, MV> = MapSetBackingMap<MK, MV>

  Parameters

  • map: M

    Underlying map.

  • codec: Codec<K, [MK, MV]> = ...

    The codec to convert keys to map entries.

  Returns MapSet<K, MK, MV, M>

[asyncIterator]

[iterator]

Readonly [rangeQueryable]

entries

keys

Readonly map

values

[toStringTag]

• get [toStringTag](): string

• Returns string

add

• add(key, options?): unknown

• Adds an entry to the set. Returns MaybePromise<unknown> to be compatible with ES Set.

  Parameters

  • key: K

  • Optional options: AbortOptions

  Returns unknown

addMany

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

• Adds the values with given keys to the set.

  Parameters

  • keys: Iterable<K>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | Error>

delete

• delete(key, options?): unknown

• Deletes an entry from the set. Returns MaybePromise<unknown> to be compatible with ES Set.

  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>

has

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

• Returns whether a value exists in the set.

  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>

updateMany

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

• Adds or deletes given list of keys.

  Parameters

  • keys: Iterable<[key: K, isAdd?: boolean]>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | Error>