Class ObservableSet<T>

constructor

• new ObservableSet<T = any>(
      initialData?: IObservableSetInitialValues<T>,
      enhancer?: IEnhancer<T>,
      name?: string,
  ): 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: T): 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: any): 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: (value: T, value2: T, set: Set<T>) => void,
      thisArg?: any,
  ): 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
  • OptionalthisArg: any

  Returns void

has

• has(value: any): 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: IInterceptor<ISetWillChange<T>>): 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: (changes: ISetDidChange<T>) => void,
      fireImmediately?: boolean,
  ): Lambda

  Parameters

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

  Returns Lambda

replace

• replace(
      other: ObservableSet<T> | IObservableSetInitialValues<T>,
  ): 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>