Class: ObservableSet<T>

Defined in: mobx:

See

https://mobx.js.org/README.html

Type Parameters

Type Parameter	Default type
T	any

Implements

• Set<T>
• IInterceptable<ISetWillChange>
• IListenable

Accessors

[toStringTag]

Get Signature

get toStringTag: string;

Defined in: mobx:

Returns

string

Implementation of

Set.[toStringTag]

---

size

Get Signature

get size(): number;

Defined in: mobx:

Returns

number

the number of (unique) elements in Set.

Implementation of

Set.size

Constructors

Constructor

new ObservableSet<T>(
   initialData?: IObservableSetInitialValues<T>, 
   enhancer?: IEnhancer<T>, 
name_?: string): ObservableSet<T>;

Defined in: mobx:

Parameters

Parameter	Type
initialData?	IObservableSetInitialValues<T>
enhancer?	IEnhancer<T>
name_?	string

Returns

ObservableSet<T>

Methods

[iterator]()

iterator: SetIterator<T>;

Defined in: mobx:

Returns

SetIterator<T>

Implementation of

Set.[iterator]

---

add()

add(value: T): this;

Defined in: mobx:

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

Parameters

Parameter	Type
value	T

Returns

this

Implementation of

Set.add

---

clear()

clear(): void;

Defined in: mobx:

Removes all elements from the Set.

Returns

void

Implementation of

Set.clear

---

delete()

delete(value: T): boolean;

Defined in: mobx:

Removes a specified value from the Set.

Parameters

Parameter	Type
value	T

Returns

boolean

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

Implementation of

Set.delete

---

difference()

difference<U>(otherSet: ReadonlySetLike<U>): Set<T>;

Defined in: mobx:

Type Parameters

Type Parameter
U

Parameters

Parameter	Type
otherSet	ReadonlySetLike<U>

Returns

Set<T>

---

entries()

entries(): SetIterator<[T, T]>;

Defined in: mobx:

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

Returns

SetIterator<[T, T]>

Implementation of

Set.entries

---

forEach()

forEach(callbackFn: (value: T, value2: T, set: Set<T>) => void, thisArg?: any): void;

Defined in: mobx:

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

Parameters

Parameter	Type
callbackFn	(value: T, value2: T, set: Set<T>) => void
thisArg?	any

Returns

void

Implementation of

Set.forEach

---

has()

has(value: T): boolean;

Defined in: mobx:

Parameters

Parameter	Type
value	T

Returns

boolean

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

Implementation of

Set.has

---

intercept_()

intercept_(handler: IInterceptor<ISetWillChange<T>>): Lambda;

Defined in: mobx:

Parameters

Parameter	Type
handler	IInterceptor<ISetWillChange<T>>

Returns

Lambda

---

intersection()

intersection<U>(otherSet: any): Set<T & U>;

Defined in: mobx:

Type Parameters

Type Parameter
U

Parameters

Parameter	Type
otherSet	any

Returns

Set<T & U>

---

isDisjointFrom()

isDisjointFrom(otherSet: any): boolean;

Defined in: mobx:

Parameters

Parameter	Type
otherSet	any

Returns

boolean

---

isSubsetOf()

isSubsetOf(otherSet: ReadonlySetLike<unknown>): boolean;

Defined in: mobx:

Parameters

Parameter	Type
otherSet	ReadonlySetLike<unknown>

Returns

boolean

---

isSupersetOf()

isSupersetOf(otherSet: ReadonlySetLike<unknown>): boolean;

Defined in: mobx:

Parameters

Parameter	Type
otherSet	ReadonlySetLike<unknown>

Returns

boolean

---

keys()

keys(): SetIterator<T>;

Defined in: mobx:

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

Returns

SetIterator<T>

Implementation of

Set.keys

---

observe_()

observe_(listener: (changes: ISetDidChange<T>) => void, fireImmediately?: boolean): Lambda;

Defined in: mobx:

Parameters

Parameter	Type
listener	(changes: ISetDidChange<T>) => void
fireImmediately?	boolean

Returns

Lambda

---

replace()

replace(other: 
  | ObservableSet<T>
| IObservableSetInitialValues<T>): ObservableSet<T>;

Defined in: mobx:

Parameters

Parameter	Type
other	| ObservableSet<T> | IObservableSetInitialValues<T>

Returns

ObservableSet<T>

---

symmetricDifference()

symmetricDifference<U>(otherSet: any): Set<T | U>;

Defined in: mobx:

Type Parameters

Type Parameter
U

Parameters

Parameter	Type
otherSet	any

Returns

Set<T | U>

---

toJSON()

toJSON(): T[];

Defined in: mobx:

Returns

T[]

---

toString()

toString(): string;

Defined in: mobx:

Returns a string representation of an object.

Returns

string

---

union()

union<U>(otherSet: any): Set<T | U>;

Defined in: mobx:

Type Parameters

Type Parameter
U

Parameters

Parameter	Type
otherSet	any

Returns

Set<T | U>

---

values()

values(): SetIterator<T>;

Defined in: mobx:

Returns an iterable of values in the set.

Returns

SetIterator<T>

Implementation of

Set.values

Properties

[$mobx]

[$mobx]: {
};

Defined in: mobx:

---

atom_

atom_: IAtom;

Defined in: mobx:

---

changeListeners_

changeListeners_: any;

Defined in: mobx:

Implementation of

IListenable.changeListeners_

---

dehancer

dehancer: any;

Defined in: mobx:

---

enhancer_

enhancer_: (newV: any, oldV: any) => any;

Defined in: mobx:

Parameters

Parameter	Type
newV	any
oldV	any

Returns

any

---

interceptors_

interceptors_: any;

Defined in: mobx:

Implementation of

IInterceptable.interceptors_

---

name_

name_: string;

Defined in: mobx: