Interface ReactiveSet<TValue>

A reactive set inherited from Set. Changes to the set will be notified to subscribers of set.$.

interface ReactiveSet<TValue> {
    $: ReadonlyVal<ReactiveSet<TValue>>;
    [toStringTag]: string;
    size: number;
    [iterator](): IterableIterator<TValue>;
    add(value): this;
    batchAdd(values): this;
    batchDelete(values): boolean;
    clear(): void;
    delete(value): boolean;
    dispose(): void;
    entries(): IterableIterator<[TValue, TValue]>;
    forEach(callbackfn, thisArg?): void;
    has(value): boolean;
    keys(): IterableIterator<TValue>;
    replace(items): Iterable<TValue>;
    toJSON(): object[];
    values(): IterableIterator<TValue>;
}

Type Parameters

  • TValue

Hierarchy

Properties

$ [toStringTag] size

Methods

[iterator] add batchAdd batchDelete clear delete dispose entries forEach has keys replace toJSON values

Properties

Readonly $

$: ReadonlyVal<ReactiveSet<TValue>>

A readonly val with value of this.

To update the entire reactive set in place, use set.replace().

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Returns

the number of (unique) elements in Set.

Methods

[iterator]

  • [iterator](): IterableIterator<TValue>

  • Iterates over values in the set.

    Returns IterableIterator<TValue>

add

  • add(value): this

  • Appends a new element with a specified value to the end of the Set.

    Parameters

    Returns this

batchAdd

batchDelete

clear

  • clear(): void

  • Returns void

delete

  • delete(value): boolean

  • Removes a specified value from the Set.

    Parameters

    Returns boolean

    Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

dispose

entries

  • entries(): IterableIterator<[TValue, TValue]>

  • Returns an iterable of [v,v] pairs for every value v in the set.

    Returns IterableIterator<[TValue, TValue]>

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each value in the Set object, in insertion order.

    Parameters

    • callbackfn: ((value, value2, set) => void)
        • (value, value2, set): void

        • Parameters

          Returns void

    • Optional thisArg: any

    Returns void

has

  • has(value): boolean

  • Parameters

    Returns boolean

    a boolean indicating whether an element with the specified value exists in the Set or not.

keys

  • keys(): IterableIterator<TValue>

  • Despite its name, returns an iterable of the values in the set.

    Returns IterableIterator<TValue>

replace

toJSON

values

  • values(): IterableIterator<TValue>

  • Returns an iterable of values in the set.

    Returns IterableIterator<TValue>

Settings

Theme

On This Page

$[toStringTag]size[iterator]addbatchAddbatchDeletecleardeletedisposeentriesforEachhaskeysreplacetoJSONvalues