Class SignalSet<T>

constructor

• new SignalSet<T>(values?: T[]): SignalSet<T>

  Type Parameters

  • T

  Parameters

  • values: T[] = []

  Returns SignalSet<T>

Readonlyarray

Readonlyempty

Readonlysize

Readonlyvalue

[iterator]

• "[iterator]"(): IterableIterator<T>

  Returns IterableIterator<T>

  Inherit Doc

add

• add(value: T): boolean

  Add a value to the collection is not already present

  Parameters

  • value: T

    The value to add

  Returns boolean

  added - Returns true if the value was added

addRange

• addRange(values: T[]): boolean

  Add a list of values to the collection is not already present

  Parameters

  • values: T[]

    The values to add

  Returns boolean

  added - Returns true if any value was added

clear

• clear(): boolean

  Clear the collection

  Returns boolean

delete

• delete(value: T): boolean

  Remove a value from the collection

  Parameters

  • value: T

    The key to remove

  Returns boolean

  removed - True if the value existed

deleteRange

• deleteRange(values: T[]): boolean

  Remove values from the collection

  Parameters

  • values: T[]

    The values to remove

  Returns boolean

  removed - True if any values were removed

filter

• filter(whitelist: ReadonlySet<T> | T[] | undefined): boolean

  Remove all keys not in the whitelist

  Parameters

  • whitelist: ReadonlySet<T> | T[] | undefined

    The keys to keep

  Returns boolean

has

• has(value: T): Signal<boolean>

  Create a signal emitting true if a key exists in the collection

  Parameters

  • value: T

  Returns Signal<boolean>

modify

• modify(modify: (set: Set<T>) => void): void

  Manually modify the inner collection

  Parameters

  • modify: (set: Set<T>) => void

  Returns void

set

• set(values?: T[]): boolean

  Reset the values in the collection to the provided list

  Parameters

  • values: T[] = []

    The values to set

  Returns boolean

  changed - Returns true if the collection changed

toggle

• toggle(value: T, state?: boolean): boolean | undefined

  Toggle a value in the set

  Parameters

  • value: T

    The value to toggle

  • Optionalstate: boolean

    A forced state (true = always add, false = always delete)

  Returns boolean | undefined

  The applied change (true = item added, false = item removed, undefined = nothing changed)