Class ObservableSet<T>

constructor

• new ObservableSet<T>(initialData?, enhancer?, name?): ObservableSet<T>

• Type Parameters

  • T = any

  Parameters

  • OptionalinitialData: IObservableSetInitialValues<T>
  • Optionalenhancer: IEnhancer<T>
  • Optionalname: string

  Returns ObservableSet<T>

[iterator]

[toStringTag]

$mobx

changeListeners

dehancer

enhancer

interceptors

name

size

• get size(): number

• Returns number

  the number of (unique) elements in Set.

add

• add(value): this

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

  Parameters

  • value: T

  Returns this

clear

• clear(): void

• Returns void

delete

• delete(value): boolean

• Removes a specified value from the Set.

  Parameters

  • value: any

  Returns boolean

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

entries

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

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

  Returns IterableIterator<[T, T]>

forEach

• forEach(callbackFn, thisArg?): void

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

  Parameters

  • callbackFn: ((value: T, value2: T, set: Set<T>) => void)
    • • (value, value2, set): void

      • Parameters

        • value: T
        • value2: T
        • set: Set<T>

        Returns void

  • OptionalthisArg: any

  Returns void

has

• has(value): boolean

• Parameters

  • value: any

  Returns boolean

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

intercept

• intercept(handler): Lambda

• Parameters

  • handler: IInterceptor<ISetWillChange<T>>

  Returns Lambda

keys

• keys(): IterableIterator<T>

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

  Returns IterableIterator<T>

observe

• observe(listener, fireImmediately?): Lambda

• Parameters

  • listener: ((changes: ISetDidChange<T>) => void)
    • • (changes): void

      • Parameters

        • changes: ISetDidChange<T>

        Returns void

  • OptionalfireImmediately: boolean

  Returns Lambda

replace

• replace(other): ObservableSet<T>

• Parameters

  • other: ObservableSet<T> | IObservableSetInitialValues<T>

  Returns ObservableSet<T>

toJS

• toJS(): Set<T>

• Returns Set<T>

toString

• toString(): string

• Returns a string representation of an object.

  Returns string

values

• values(): IterableIterator<T>

• Returns an iterable of values in the set.

  Returns IterableIterator<T>