Class TransformedSet<T, U, S>

A set adapter that serializes values with a codec. Codec needs to be monotonic to preserve iteration order.

Type Parameters

T
U = T
S extends MaybeAsyncSet & Partial<MaybeAsyncSetBatch & Iterable & AsyncIterable & RangeQueryable<U, U>> = MaybeAsyncSet & Partial<MaybeAsyncSetBatch & Iterable & AsyncIterable & RangeQueryable<U, U>>

Implements

MaybeAsyncSet<T>
MaybeAsyncSetBatch<T>
Partial<Iterable<T> & AsyncIterable<T> & RangeQueryable<T, T>>

Index

Constructors

constructor

new TransformedSet<T, U, S>(set, codec?): TransformedSet<T, U, S>
Type Parameters
- T
- U = T
- S extends MaybeAsyncSet & Partial<MaybeAsyncSetBatch & Iterable & AsyncIterable & RangeQueryable<U, U>> = MaybeAsyncSet & Partial<MaybeAsyncSetBatch & Iterable & AsyncIterable & RangeQueryable<U, U>>
Parameters
- set: S
 Underlying set.
- codec: Codec<T, U> = ...
 Key codec.
Returns TransformedSet<T, U, S>
- Defined in collections/src/impl/transformedset.ts:24

Properties

[asyncIterator]

[asyncIterator]: S extends Iterable | AsyncIterable
? (() => AsyncIterableIterator<T>)
: undefined

[iterator]

[iterator]: S extends Iterable
? (() => IterableIterator<T>)
: undefined

`Readonly` [rangeQueryable]

[rangeQueryable]: S extends RangeQueryable<U, U>
? true
: undefined

`Protected` `Readonly` codec

codec: Codec<T, U> = ...

Key codec.

entries

entries: TransformedSetQuery<T, U, S, [T, T]>

keys

keys: TransformedSetQuery<T, U, S, T>

`Readonly` set

set: S

Underlying set.

values

values: TransformedSetQuery<T, U, S, T>

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in collections/src/impl/transformedset.ts:96

Methods

add

add(value, options?): unknown
Adds an entry to the set. Returns MaybePromise<unknown> to be compatible with ES Set.
Parameters
- value: T
- Optional options: AbortOptions
Returns unknown
Implementation of MaybeAsyncSet.add
- Defined in collections/src/impl/transformedset.ts:66

addMany

addMany(keys, options?): AsyncIterableIterator<undefined | Error>
Adds the values with given keys to the set.
Parameters
- keys: Iterable<T>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncSetBatch.addMany
- Defined in collections/src/impl/transformedset.ts:78

delete

delete(value, options?): unknown
Deletes an entry from the set. Returns MaybePromise<unknown> to be compatible with ES Set.
Parameters
- value: T
- Optional options: AbortOptions
Returns unknown
Implementation of MaybeAsyncSet.delete
- Defined in collections/src/impl/transformedset.ts:70

deleteMany

deleteMany(keys, options?): AsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<T>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncSetBatch.deleteMany
- Defined in collections/src/impl/transformedset.ts:82

`Protected` encode

encode(key): U
Parameters
- key: T
Returns U
- Defined in collections/src/impl/transformedset.ts:100

has

has(value, options?): MaybePromise<boolean>
Returns whether a value exists in the set.
Parameters
- value: T
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Implementation of MaybeAsyncSet.has
- Defined in collections/src/impl/transformedset.ts:74

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<T>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of MaybeAsyncSetBatch.hasMany
- Defined in collections/src/impl/transformedset.ts:86

updateMany

updateMany(keys, options?): AsyncIterableIterator<undefined | Error>
Adds or deletes given list of keys.
Parameters
- keys: Iterable<[key: T, isAdd?: boolean]>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncSetBatch.updateMany
- Defined in collections/src/impl/transformedset.ts:90

Class TransformedSet<T, U, S>

Type Parameters

T

U = T

S extends MaybeAsyncSet<U> & Partial<MaybeAsyncSetBatch<U> & Iterable<U> & AsyncIterable<U> & RangeQueryable<U, U>> = MaybeAsyncSet<U> & Partial<MaybeAsyncSetBatch<U> & Iterable<U> & AsyncIterable<U> & RangeQueryable<U, U>>

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

U = T

S extends MaybeAsyncSet<U> & Partial<MaybeAsyncSetBatch<U> & Iterable<U> & AsyncIterable<U> & RangeQueryable<U, U>> = MaybeAsyncSet<U> & Partial<MaybeAsyncSetBatch<U> & Iterable<U> & AsyncIterable<U> & RangeQueryable<U, U>>

Parameters

set: S

codec: Codec<T, U> = ...

Returns TransformedSet<T, U, S>

Properties

[asyncIterator]

[iterator]

Readonly [rangeQueryable]

Protected Readonly codec

entries

keys

Readonly set

values

Accessors

[toStringTag]

Returns string

Methods

add

Parameters

value: T

Optional options: AbortOptions

Returns unknown

addMany

Parameters

keys: Iterable<T>

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | Error>

delete

Parameters

value: T

Optional options: AbortOptions

Returns unknown

deleteMany

Parameters

keys: Iterable<T>

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | Error>

Protected encode

Parameters

key: T

Returns U

has

Parameters

value: T

Optional options: AbortOptions

Returns MaybePromise<boolean>

hasMany

Parameters

keys: Iterable<T>

Optional options: AbortOptions

Returns AsyncIterableIterator<boolean>

updateMany

Parameters

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

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | Error>

Settings

Member Visibility

Theme

On This Page

`Readonly` [rangeQueryable]

`Protected` `Readonly` codec

`Readonly` set

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Protected` encode

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions