Class WatchableSet<K>

A Set that implements Watchable, notifying subscribers after add/delete/clear.

Type Parameters

Hierarchy

Set<K>
- WatchableSet

Implements

Watchable

Index

Constructors

constructor

new WatchableSet<K>(values?: readonly K[] | null): WatchableSet<K>
Type Parameters
- K
Parameters
- Optionalvalues: readonly K[] | null
Returns WatchableSet<K>
Inherited from Set<K>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116
new WatchableSet<K>(iterable?: Iterable<K, any, any> | null): WatchableSet<K>
Type Parameters
- K
Parameters
- Optionaliterable: Iterable<K, any, any> | null
Returns WatchableSet<K>
Inherited from Set<K>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116

Properties

`Static` `Readonly`[species]

"[species]": SetConstructor

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

Methods

[iterator]

"[iterator]"(): SetIterator<K>
Iterates over values in the set.

Returns SetIterator<K>
Inherited from Set.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:198

add

add(key: K): WatchableSet<K>
Appends a new element with a specified value to the end of the Set.
Parameters
- key: K
Returns WatchableSet<K>
Overrides Set.add
- Defined in src/reactivity.ts:73

clear

clear(): void
Returns void
Overrides Set.clear
- Defined in src/reactivity.ts:87

delete

delete(key: K): boolean
Removes a specified value from the Set.
Parameters
- key: K
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.
Overrides Set.delete
- Defined in src/reactivity.ts:80

difference

difference(other: ReadonlySetLike): Set<K>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<K>
a new Set containing all the elements in this Set which are not also in the argument.
Inherited from Set.difference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:48

entries

entries(): SetIterator<[K, K]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[K, K]>
Inherited from Set.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:203

forEach

forEach(
callbackfn: (value: K, value2: K, set: Set<K>) => void,
thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: K, value2: K, set: Set<K>) => void
- OptionalthisArg: any
Returns void
Inherited from Set.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:104

has

has(value: K): boolean
Parameters
- value: K
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Inherited from Set.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:108

intersection

intersection(other: ReadonlySetLike): Set<K & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<K & U>
a new Set containing all the elements which are both in this Set and in the argument.
Inherited from Set.intersection
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:44

isDisjointFrom

isDisjointFrom(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether this Set has no elements in common with the argument.
Inherited from Set.isDisjointFrom
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:64

isSubsetOf

isSubsetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in this Set are also in the argument.
Inherited from Set.isSubsetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:56

isSupersetOf

isSupersetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in the argument are also in this Set.
Inherited from Set.isSupersetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:60

keys

keys(): SetIterator<K>
Despite its name, returns an iterable of the values in the set.

Returns SetIterator<K>
Inherited from Set.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:208

`Protected`notify

notify(): void
Returns void
- Defined in src/reactivity.ts:70

subscribe(onChange: () => void): () => void
Registers a mutation listener and returns a function that unregisters it.
Parameters
- onChange: () => void
Returns () => void
Implementation of Watchable.subscribe
- Defined in src/reactivity.ts:66

symmetricDifference

symmetricDifference(other: ReadonlySetLike): Set<K | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<K | U>
a new Set containing all the elements which are in either this Set or in the argument, but not in both.
Inherited from Set.symmetricDifference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:52

union

union(other: ReadonlySetLike): Set<K | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<K | U>
a new Set containing all the elements in this Set and also all the elements in the argument.
Inherited from Set.union
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:40

values

values(): SetIterator<K>
Returns an iterable of values in the set.

Returns SetIterator<K>
Inherited from Set.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:213

Class WatchableSet<K>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WatchableSet<K>

Type Parameters

Parameters

Returns WatchableSet<K>

Properties

Static Readonly[species]

Readonly[toStringTag]

Readonlysize

Returns

Methods

[iterator]

Returns SetIterator<K>

add

Parameters

Returns WatchableSet<K>

clear

Returns void

delete

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns Set<K>

entries

Returns SetIterator<[K, K]>

forEach

Parameters

Returns void

has

Parameters

Returns boolean

intersection

Type Parameters

Parameters

Returns Set<K & U>

isDisjointFrom

Parameters

Returns boolean

isSubsetOf

Parameters

Returns boolean

isSupersetOf

Parameters

Returns boolean

keys

Returns SetIterator<K>

Protectednotify

Returns void

subscribe

Parameters

Returns () => void

symmetricDifference

Type Parameters

Parameters

Returns Set<K | U>

union

Type Parameters

Parameters

Returns Set<K | U>

values

Returns SetIterator<K>

Settings

On This Page

`Static` `Readonly`[species]

`Readonly`[toStringTag]

`Readonly`size

`Protected`notify