Class SignalMap<TKey, TVal>

constructor

• new SignalMap<TKey, TVal>(
      values?: ReadonlyMap<TKey, TVal>,
  ): SignalMap<TKey, TVal>

  Type Parameters

  • TKey
  • TVal

  Parameters

  • Optionalvalues: ReadonlyMap<TKey, TVal>

  Returns SignalMap<TKey, TVal>

Readonlyempty

Readonlysize

Readonlyvalue

[iterator]

• "[iterator]"(): IterableIterator<[TKey, TVal]>

  Returns IterableIterator<[TKey, TVal]>

add

• add(key: TKey, value: TVal): boolean

  Add a value to the collection if the key is not in use

  Parameters

  • key: TKey

    The key to use

  • value: TVal

    The value to add

  Returns boolean

  added - Returns true if the value was added

clear

• clear(): boolean

  Clear the collection

  Returns boolean

delete

• delete(key: TKey): boolean

  Remove a key from the collection

  Parameters

  • key: TKey

    The key to remove

  Returns boolean

  removed - True if an item was removed

deleteRange

• deleteRange(values: TKey[]): boolean

  Remove keys from the collection

  Parameters

  • values: TKey[]

    The keys to remove

  Returns boolean

  removed - True if items were removed

filter

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

  Remove all keys not in the whitelist

  Parameters

  • whitelist: readonly TKey[] | ReadonlySet<TKey> | undefined

    The keys to keep

  Returns boolean

get

• get(key: TKey): Signal<TVal | undefined>

  Create a signal emitting the value under a given key

  Parameters

  • key: TKey

  Returns Signal<TVal | undefined>

has

• has(key: TKey): Signal<boolean>

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

  Parameters

  • key: TKey

  Returns Signal<boolean>

modify

• modify(modify: (map: Map<TKey, TVal>) => void): void

  Manually modify the inner collection

  Parameters

  • modify: (map: Map<TKey, TVal>) => void

  Returns void

set

• set(key: TKey, value: TVal): boolean

  Add a value to the collection

  Parameters

  • key: TKey

    The key to use

  • value: TVal

    The value to add

  Returns boolean

  added - Returns true if the value was added or changed

toggle

• toggle(key: TKey, value: TVal, state?: boolean): boolean | undefined

  Toggle a value in the map

  Parameters

  • key: TKey

    The key to toggle

  • value: TVal

    The value to insert if applicable

  • 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)