Skip to main content

Interface: MutableSubscribableSet<T>

Defined in: src/sdk/sub/SubscribableSet.ts:77

A subscribable set which can accept inputs to add or remove keys.

Extends

Type Parameters

Type Parameter
T

Properties

isMutableSubscribableSet

readonly isMutableSubscribableSet: true

Defined in: src/sdk/sub/SubscribableSet.ts:79

Flags this object as a MutableSubscribableSet.


isSubscribableSet

readonly isSubscribableSet: true

Defined in: src/sdk/sub/SubscribableSet.ts:24

Flags this object as a SubscribableSet.

Inherited from

SubscribableSet.isSubscribableSet


size

readonly size: number

Defined in: src/sdk/sub/SubscribableSet.ts:27

The number of elements contained in this set.

Inherited from

SubscribableSet.size

Methods

add()

add(key): this

Defined in: src/sdk/sub/SubscribableSet.ts:86

Adds a key to this set.

Parameters

ParameterTypeDescription
keyTThe key to add.

Returns

this

This set, after the key has been added.


clear()

clear(): void

Defined in: src/sdk/sub/SubscribableSet.ts:114

Removes all keys from this set.

Returns

void


delete()

delete(key): boolean

Defined in: src/sdk/sub/SubscribableSet.ts:93

Removes a key from this set.

Parameters

ParameterTypeDescription
keyTThe key to remove.

Returns

boolean

Whether the key was removed.


get()

get(): ReadonlySet<T>

Defined in: src/sdk/sub/SubscribableSet.ts:33

Gets a read-only version of this set.

Returns

ReadonlySet<T>

A read-only version of this set.

Inherited from

SubscribableSet.get


has()

has(key): boolean

Defined in: src/sdk/sub/SubscribableSet.ts:40

Checks whether this set contains a key.

Parameters

ParameterTypeDescription
keyTThe key to check.

Returns

boolean

Whether this set contains the specified key.

Inherited from

SubscribableSet.has


pipe()

Call Signature

pipe(to, paused?): Subscription

Defined in: src/sdk/sub/SubscribableSet.ts:59

Subscribes to and pipes this set's state to a mutable subscribable set. Whenever a key added or removed event is received through the subscription, the same key will be added to or removed from the other set.

Parameters
ParameterTypeDescription
toMutableSubscribableSet<T>The mutable subscribable set to which to pipe this set's state.
paused?booleanWhether the new subscription should be initialized as paused. Defaults to false.
Returns

Subscription

The new subscription.

Inherited from

SubscribableSet.pipe

Call Signature

pipe<M>(to, map, paused?): Subscription

Defined in: src/sdk/sub/SubscribableSet.ts:71

Subscribes to this set's state and pipes a mapped version to a mutable subscribable set. Whenever a key added event is received through the subscription, the key will be transformed by the specified mapping function, and the transformed key will be added to the other set. Whenever a key removed event is received, the transformed key is removed from the other set if and only if no remaining key in this set maps to the same transformed key.

Type Parameters
Type Parameter
M
Parameters
ParameterTypeDescription
toMutableSubscribableSet<M>The mutable subscribable to which to pipe this set's mapped state.
map(input) => MThe function to use to transform keys.
paused?booleanWhether the new subscription should be initialized as paused. Defaults to false.
Returns

Subscription

The new subscription.

Inherited from

SubscribableSet.pipe


sub()

sub(handler, initialNotify?, paused?): Subscription

Defined in: src/sdk/sub/SubscribableSet.ts:50

Subscribes to changes in this set's state.

Parameters

ParameterTypeDescription
handlerSubscribableSetHandler<T>A function which is called when this set's state changes.
initialNotify?booleanWhether to immediately invoke the callback function with this set's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused.
paused?booleanWhether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Inherited from

SubscribableSet.sub


toggle()

Call Signature

toggle(key): boolean

Defined in: src/sdk/sub/SubscribableSet.ts:101

Toggles the presence of a key in this set.

Parameters
ParameterTypeDescription
keyTThe key to toggle.
Returns

boolean

Whether the key is present in this set after the toggle operation.

Call Signature

toggle(key, force): boolean

Defined in: src/sdk/sub/SubscribableSet.ts:109

Toggles the presence of a key in this set.

Parameters
ParameterTypeDescription
keyTThe key to toggle.
forcebooleanThe state of the key to force. If true, the key will be added to this set. If false, the key will be removed from this set.
Returns

boolean

Whether the key is present in this set after the toggle operation.