Class ValueSet<VALUE>

An implementation of a Set data structure.

Type Parameters

VALUE

Hierarchy (View Summary)

BaseContainer
- ValueSet

Implements

KVComponent<[VALUE], VALUE>

Index

Constructors

constructor

Accessors

size

Constructors

constructor

new ValueSet<VALUE>(): ValueSet<VALUE>
Type Parameters
- VALUE
Returns ValueSet<VALUE>
Overrides BaseContainer.constructor
new ValueSet<VALUE>(equals?: EqualityFn<VALUE>): ValueSet<VALUE>
Type Parameters
- VALUE
Parameters
- Optionalequals: EqualityFn<VALUE>
Returns ValueSet<VALUE>
Overrides BaseContainer.constructor
new ValueSet<VALUE>(
list: ValueSet<VALUE> | Iterable<VALUE, any, any>,
equals?: EqualityFn<VALUE>,
): ValueSet<VALUE>
Type Parameters
- VALUE
Parameters
- list: ValueSet<VALUE> | Iterable<VALUE, any, any>
- Optionalequals: EqualityFn<VALUE>
Returns ValueSet<VALUE>
Overrides BaseContainer.constructor

Accessors

size

get size(): number
Returns number
Implementation of KVComponent.size

Methods

[iterator]

"[iterator]"(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>

add

add(value: VALUE): VALUE
Parameters
- value: VALUE
Returns VALUE

clear

clear(): void
Returns void
Implementation of KVComponent.clear

clone

clone(): ValueSet<VALUE>
Returns ValueSet<VALUE>

delete

delete(value: VALUE): boolean
Parameters
- value: VALUE
Returns boolean
Implementation of KVComponent.delete

entries

entries(): IterableIterator<[VALUE, VALUE]>
Returns IterableIterator<[VALUE, VALUE]>

every

every(fn: (value: VALUE) => boolean): boolean
Parameters
- fn: (value: VALUE) => boolean
Returns boolean

filter

filter<R>(
predicate: (value: VALUE, set: ValueSet<VALUE>) => value is R,
): ValueSet<R>
Type Parameters
- R
Parameters
- predicate: (value: VALUE, set: ValueSet<VALUE>) => value is R
Returns ValueSet<R>
filter(
predicate: (value: VALUE, set1: ValueSet<VALUE>) => unknown,
): ValueSet<VALUE>
Parameters
- predicate: (value: VALUE, set1: ValueSet<VALUE>) => unknown
Returns ValueSet<VALUE>

forEach

forEach(
callbackfn: (value: VALUE, set: ValueSet<VALUE>) => void,
thisArg?: any,
): void
Parameters
- callbackfn: (value: VALUE, set: ValueSet<VALUE>) => void
- OptionalthisArg: any
Returns void

get

get(key: VALUE): VALUE | undefined
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- key: VALUE
Returns VALUE | undefined
Implementation of KVComponent.get

getOrCreate

getOrCreate(key: VALUE, value: VALUE): VALUE
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- key: VALUE
- value: VALUE
Returns VALUE
Implementation of KVComponent.getOrCreate
getOrCreate(key: VALUE, creator: () => VALUE): VALUE
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- key: VALUE
- creator: () => VALUE
Returns VALUE
Implementation of KVComponent.getOrCreate

getOrDefault

getOrDefault(key: VALUE, defaultValue: VALUE): VALUE
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- key: VALUE
- defaultValue: VALUE
Returns VALUE
Implementation of KVComponent.getOrDefault

has

has(value: VALUE): boolean
Parameters
- value: VALUE
Returns boolean
Implementation of KVComponent.has

isEmpty

isEmpty(): boolean
Returns boolean
Implementation of KVComponent.isEmpty

keys

keys(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>

kvEntries

kvEntries(): IterableIterator<[[VALUE], VALUE]>
Returns IterableIterator<[[VALUE], VALUE]>
Implementation of KVComponent.kvEntries

kvKeys

kvKeys(): IterableIterator<[VALUE]>
Returns IterableIterator<[VALUE]>
Implementation of KVComponent.kvKeys

kvValues

kvValues(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>
Implementation of KVComponent.kvValues

map

map<R = VALUE>(fn: (value: VALUE) => R): ValueSet<R>
Type Parameters
- R = VALUE
Parameters
- fn: (value: VALUE) => R
Returns ValueSet<R>

mapToArray

mapToArray<R = VALUE>(fn: (value: VALUE) => R): R[]
Type Parameters
- R = VALUE
Parameters
- fn: (value: VALUE) => R
Returns R[]

mapValues

mapValues<R = VALUE>(fn: (value: VALUE) => R): ValueSet<R>
Type Parameters
- R = VALUE
Parameters
- fn: (value: VALUE) => R
Returns ValueSet<R>

merge

merge(other: ValueSet<VALUE>): this
Parameters
- other: ValueSet<VALUE>
Returns this

reduce

reduce(fn: (acc: VALUE, value: VALUE) => VALUE): VALUE
Parameters
- fn: (acc: VALUE, value: VALUE) => VALUE
Returns VALUE
reduce<R = VALUE>(fn: (acc: R, value: VALUE) => R, init: R): R
Type Parameters
- R = VALUE
Parameters
- fn: (acc: R, value: VALUE) => R
- init: R
Returns R

set

set(key: VALUE, value: VALUE): void
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- key: VALUE
- value: VALUE
Returns void
Implementation of KVComponent.set

some

some(fn: (value: VALUE) => boolean): boolean
Parameters
- fn: (value: VALUE) => boolean
Returns boolean

toArray

toArray(): VALUE[]
Returns VALUE[]

toSet

toSet(): Set<VALUE>
Returns Set<VALUE>

toString

toString(): string
Returns string
Implementation of KVComponent.toString
Overrides BaseContainer.toString

values

values(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>

`Static`createDeep

createDeep<VALUE>(): ValueSet<VALUE>
Type Parameters
- VALUE
Returns ValueSet<VALUE>
createDeep<VALUE>(set: ValueSet<VALUE>): ValueSet<VALUE>
Type Parameters
- VALUE
Parameters
- set: ValueSet<VALUE>
Returns ValueSet<VALUE>
createDeep<VALUE>(entries: Iterable<VALUE>): ValueSet<VALUE>
Type Parameters
- VALUE
Parameters
- entries: Iterable<VALUE>
Returns ValueSet<VALUE>

Class ValueSet<VALUE>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns ValueSet<VALUE>

Type Parameters

Parameters

Returns ValueSet<VALUE>

Type Parameters

Parameters

Returns ValueSet<VALUE>

Accessors

size

Returns number

Methods

[iterator]

Returns IterableIterator<VALUE>

add

Parameters

Returns VALUE

clear

Returns void

clone

Returns ValueSet<VALUE>

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[VALUE, VALUE]>

every

Parameters

Returns boolean

filter

Type Parameters

Parameters

Returns ValueSet<R>

Parameters

Returns ValueSet<VALUE>

forEach

Parameters

Returns void

get

Parameters

Returns VALUE | undefined

getOrCreate

Parameters

Returns VALUE

Parameters

Returns VALUE

getOrDefault

Parameters

Returns VALUE

has

Parameters

Returns boolean

isEmpty

Returns boolean

keys

Returns IterableIterator<VALUE>

kvEntries

Returns IterableIterator<[[VALUE], VALUE]>

kvKeys

Returns IterableIterator<[VALUE]>

kvValues

Returns IterableIterator<VALUE>

map

Type Parameters

Parameters

Returns ValueSet<R>

mapToArray

Type Parameters

Parameters

Returns R[]

`Static`createDeep