Class BTreeSet<K>

A MapSet backed by BTreeMap.

Type Parameters

Hierarchy

MapSet<K, K, K, BTreeMap<K, K>>
- BTreeSet

Index

Constructors

constructor

new BTreeSet<K>(order?, compare?): BTreeSet<K>
Type Parameters
- K
Parameters
- Optional order: number
  Order of the tree, which is the maximum branching factor / number of children of a node. Must be >= 2.
- Optional compare: ((a, b) => number)
  Function that defines the sort order of keys.
  - - (a, b): number
    - Function that defines the sort order of keys.
      
      Parameters
      a: K
      b: K
      Returns number
Returns BTreeSet<K>
Overrides MapSet.constructor
- Defined in collections/src/impl/mapset.ts:111

Properties

[asyncIterator]

[asyncIterator]: (() => AsyncIterableIterator<K>)

Type declaration

- (): AsyncIterableIterator<K>
- Returns AsyncIterableIterator<K>

[iterator]

[iterator]: (() => IterableIterator<K>)

Type declaration

- (): IterableIterator<K>
- Returns IterableIterator<K>

`Readonly` [rangeQueryable]

[rangeQueryable]: true

`Protected` `Readonly` codec

codec: Codec<K, [K, K]> = ...

The codec to convert keys to map entries.

`Protected` `Optional` `Readonly` compare

compare?: ((a, b) => number)

Type declaration

- (a, b): number
- Function that defines the sort order of keys.
  Parameters
  - a: K
  - b: K
  Returns number

entries

entries: ((options?) => AsyncIterableIterator<[K, K]>)

Type declaration

- (options?): AsyncIterableIterator<[K, K]>
- Parameters
  - Optional options: RangeQueryOptions<K>
  Returns AsyncIterableIterator<[K, K]>

keys

keys: ((options?) => AsyncIterableIterator<K>)

Type declaration

- (options?): AsyncIterableIterator<K>
- Parameters
  - Optional options: RangeQueryOptions<K>
  Returns AsyncIterableIterator<K>

`Readonly` map

map: BTreeMap<K, K>

Underlying map.

`Optional` `Readonly` order

order?: number

Order of the tree, which is the maximum branching factor / number of children of a node. Must be >= 2.

values

values: ((options?) => AsyncIterableIterator<K>)

Type declaration

- (options?): AsyncIterableIterator<K>
- Parameters
  - Optional options: RangeQueryOptions<K>
  Returns AsyncIterableIterator<K>

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Overrides MapSet.[toStringTag]
- Defined in collections/src/impl/mapset.ts:125

size

get size(): number
Returns the number of elements in the tree.

Returns number
- Defined in collections/src/impl/mapset.ts:121

Methods

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
Inherited from MapSet.add
- Defined in collections/src/impl/mapset.ts:61

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>
Inherited from MapSet.addMany
- Defined in collections/src/impl/mapset.ts:74

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
Inherited from MapSet.delete
- Defined in collections/src/impl/mapset.ts:66

deleteMany

deleteMany(keys, options?): AsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Inherited from MapSet.deleteMany
- Defined in collections/src/impl/mapset.ts:78

has

has(key, options?): MaybePromise<boolean>
Returns whether a value exists in the set.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Inherited from MapSet.has
- Defined in collections/src/impl/mapset.ts:70

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Inherited from MapSet.hasMany
- Defined in collections/src/impl/mapset.ts:82

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>
Inherited from MapSet.updateMany
- Defined in collections/src/impl/mapset.ts:86

Class BTreeSet<K>

Type Parameters

K

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

Parameters

Optional order: number

Optional compare: ((a, b) => number)

Parameters

a: K

b: K

Returns number

Returns BTreeSet<K>

Properties

[asyncIterator]

Type declaration

Returns AsyncIterableIterator<K>

[iterator]

Type declaration

Returns IterableIterator<K>

Readonly [rangeQueryable]

Protected Readonly codec

Protected Optional Readonly compare

Type declaration

Parameters

a: K

b: K

Returns number

entries

Type declaration

Parameters

Optional options: RangeQueryOptions<K>

Returns AsyncIterableIterator<[K, K]>

keys

Type declaration

Parameters

Optional options: RangeQueryOptions<K>

Returns AsyncIterableIterator<K>

Readonly map

Optional Readonly order

values

Type declaration

Parameters

Optional options: RangeQueryOptions<K>

Returns AsyncIterableIterator<K>

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

add

Parameters

key: K

Optional options: AbortOptions

Returns unknown

addMany

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | Error>

delete

Parameters

key: K

Optional options: AbortOptions

Returns unknown

deleteMany

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | Error>

has

`Optional` order: number

`Optional` compare: ((a, b) => number)

`Readonly` [rangeQueryable]

`Protected` `Readonly` codec

`Protected` `Optional` `Readonly` compare

`Optional` options: RangeQueryOptions<K>

`Optional` options: RangeQueryOptions<K>

`Readonly` map

`Optional` `Readonly` order

`Optional` options: RangeQueryOptions<K>

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions