Interface: IObservableArray<T>

Defined in: mobx:

See

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

Extends

• Array<T>

Type Parameters

Type Parameter	Default type
T	any

Indexable

[n: number]: T

Methods

[iterator]()

iterator: ArrayIterator<T>;

Defined in: typescript:

Iterator

Returns

ArrayIterator<T>

Inherited from

Array.[iterator]

---

at()

at(index: number): T | undefined;

Defined in: typescript:

Returns the item located at the specified index.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

T | undefined

Inherited from

Array.at

---

clear()

clear(): T[];

Defined in: mobx:

Returns

T[]

---

concat()

Call Signature

concat(...items: ConcatArray<T>[]): T[];

Defined in: typescript:

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Parameter	Type	Description
...items	ConcatArray<T>[]	Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited from

Array.concat

Call Signature

concat(...items: (T | ConcatArray<T>)[]): T[];

Defined in: typescript:

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Parameter	Type	Description
...items	(T | ConcatArray<T>)[]	Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited from

Array.concat

---

copyWithin()

copyWithin(
   target: number, 
   start: number, 
   end?: number): this;

Defined in: typescript:

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

Parameter	Type	Description
target	number	If target is negative, it is treated as length+target where length is the length of the array.
start	number	If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
end?	number	If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Array.copyWithin

---

entries()

entries(): ArrayIterator<[number, T]>;

Defined in: typescript:

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, T]>

Inherited from

Array.entries

---

every()

Call Signature

every<S>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): this is S[];

Defined in: typescript:

Determines whether all the members of an array satisfy the specified test.

Type Parameters

Type Parameter
S

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, array: T[]) => value is S	A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
thisArg?	any	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

Array.every

Call Signature

every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean;

Defined in: typescript:

Determines whether all the members of an array satisfy the specified test.

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, array: T[]) => unknown	A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
thisArg?	any	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.every

---

fill()

fill(
   value: T, 
   start?: number, 
   end?: number): this;

Defined in: typescript:

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

Parameter	Type	Description
value	T	value to fill array section with
start?	number	index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
end?	number	index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Array.fill

---

filter()

Call Signature

filter<S>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[];

Defined in: typescript:

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

Type Parameter
S

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, array: T[]) => value is S	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
thisArg?	any	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

Array.filter

Call Signature

filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[];

Defined in: typescript:

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, array: T[]) => unknown	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
thisArg?	any	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

T[]

Inherited from

Array.filter

---

find()

Call Signature

find<S>(predicate: (value: T, index: number, obj: T[]) => value is S, thisArg?: any): S | undefined;

Defined in: typescript:

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

Type Parameter
S

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, obj: T[]) => value is S	find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
thisArg?	any	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S | undefined

Inherited from

Array.find

Call Signature

find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T | undefined;

Defined in: typescript:

Parameters

Parameter	Type
predicate	(value: T, index: number, obj: T[]) => unknown
thisArg?	any

Returns

T | undefined

Inherited from

Array.find

---

findIndex()

findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number;

Defined in: typescript:

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, obj: T[]) => unknown	find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
thisArg?	any	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Array.findIndex

---

flat()

flat<A, D>(this: A, depth?: D): FlatArray<A, D>[];

Defined in: typescript:

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

Type Parameter	Default type
A	-
D extends number	1

Parameters

Parameter	Type	Description
this	A	-
depth?	D	The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

---

flatMap()

flatMap<U, This>(callback: (this: This, value: T, index: number, array: T[]) => U | readonly U[], thisArg?: This): U[];

Defined in: typescript:

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

Type Parameter	Default type
U	-
This	undefined

Parameters

Parameter	Type	Description
callback	(this: This, value: T, index: number, array: T[]) => U | readonly U[]	A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
thisArg?	This	An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.flatMap

---

forEach()

forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void;

Defined in: typescript:

Performs the specified action for each element in an array.

Parameters

Parameter	Type	Description
callbackfn	(value: T, index: number, array: T[]) => void	A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
thisArg?	any	An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Array.forEach

---

includes()

includes(searchElement: T, fromIndex?: number): boolean;

Defined in: typescript:

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

Parameter	Type	Description
searchElement	T	The element to search for.
fromIndex?	number	The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Array.includes

---

indexOf()

indexOf(searchElement: T, fromIndex?: number): number;

Defined in: typescript:

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

Parameter	Type	Description
searchElement	T	The value to locate in the array.
fromIndex?	number	The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Array.indexOf

---

join()

join(separator?: string): string;

Defined in: typescript:

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

Parameter	Type	Description
separator?	string	A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

---

keys()

keys(): ArrayIterator<number>;

Defined in: typescript:

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Array.keys

---

lastIndexOf()

lastIndexOf(searchElement: T, fromIndex?: number): number;

Defined in: typescript:

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

Parameter	Type	Description
searchElement	T	The value to locate in the array.
fromIndex?	number	The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

---

map()

map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[];

Defined in: typescript:

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

Type Parameter
U

Parameters

Parameter	Type	Description
callbackfn	(value: T, index: number, array: T[]) => U	A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
thisArg?	any	An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.map

---

pop()

pop(): T | undefined;

Defined in: typescript:

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

T | undefined

Inherited from

Array.pop

---

push()

push(...items: T[]): number;

Defined in: typescript:

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

Parameter	Type	Description
...items	T[]	New elements to add to the array.

Returns

number

Inherited from

Array.push

---

reduce()

Call Signature

reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T;

Defined in: typescript:

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

Parameter	Type	Description
callbackfn	(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T	A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

T

Inherited from

Array.reduce

Call Signature

reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T;

Defined in: typescript:

Parameters

Parameter	Type
callbackfn	(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T
initialValue	T

Returns

T

Inherited from

Array.reduce

Call Signature

reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;

Defined in: typescript:

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

Type Parameter
U

Parameters

Parameter	Type	Description
callbackfn	(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U	A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue	U	If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T;

Defined in: typescript:

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

Parameter	Type	Description
callbackfn	(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T	A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

T

Inherited from

Array.reduceRight

Call Signature

reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T;

Defined in: typescript:

Parameters

Parameter	Type
callbackfn	(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T
initialValue	T

Returns

T

Inherited from

Array.reduceRight

Call Signature

reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;

Defined in: typescript:

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

Type Parameter
U

Parameters

Parameter	Type	Description
callbackfn	(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U	A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue	U	If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduceRight

---

remove()

remove(value: T): boolean;

Defined in: mobx:

Parameters

Parameter	Type
value	T

Returns

boolean

---

replace()

replace(newItems: T[]): T[];

Defined in: mobx:

Parameters

Parameter	Type
newItems	T[]

Returns

T[]

---

reverse()

reverse(): T[];

Defined in: typescript:

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

T[]

Inherited from

Array.reverse

---

shift()

shift(): T | undefined;

Defined in: typescript:

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

T | undefined

Inherited from

Array.shift

---

slice()

slice(start?: number, end?: number): T[];

Defined in: typescript:

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

Parameter	Type	Description
start?	number	The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
end?	number	The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

T[]

Inherited from

Array.slice

---

some()

some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean;

Defined in: typescript:

Determines whether the specified callback function returns true for any element of an array.

Parameters

Parameter	Type	Description
predicate	(value: T, index: number, array: T[]) => unknown	A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
thisArg?	any	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.some

---

sort()

sort(compareFn?: (a: T, b: T) => number): this;

Defined in: typescript:

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

Parameter	Type	Description
compareFn?	(a: T, b: T) => number	Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. [11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Array.sort

---

splice()

Call Signature

splice(start: number, deleteCount?: number): T[];

Defined in: typescript:

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Parameter	Type	Description
start	number	The zero-based location in the array from which to start removing elements.
deleteCount?	number	The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns

T[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Call Signature

splice(
   start: number, 
   deleteCount: number, ...
   items: T[]): T[];

Defined in: typescript:

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Parameter	Type	Description
start	number	The zero-based location in the array from which to start removing elements.
deleteCount	number	The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.
...items	T[]	Elements to insert into the array in place of the deleted elements.

Returns

T[]

An array containing the elements that were deleted.

Inherited from

Array.splice

---

spliceWithArray()

spliceWithArray(
   index: number, 
   deleteCount?: number, 
   newItems?: T[]): T[];

Defined in: mobx:

Parameters

Parameter	Type
index	number
deleteCount?	number
newItems?	T[]

Returns

T[]

---

toJSON()

toJSON(): T[];

Defined in: mobx:

Returns

T[]

---

toLocaleString()

Call Signature

toLocaleString(): string;

Defined in: typescript:

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Array.toLocaleString

Call Signature

toLocaleString(locales: string | string[], options?: NumberFormatOptions & DateTimeFormatOptions): string;

Defined in: typescript:

Parameters

Parameter	Type
locales	string | string[]
options?	NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Array.toLocaleString

---

toString()

toString(): string;

Defined in: typescript:

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

---

unshift()

unshift(...items: T[]): number;

Defined in: typescript:

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

Parameter	Type	Description
...items	T[]	Elements to insert at the start of the array.

Returns

number

Inherited from

Array.unshift

---

values()

values(): ArrayIterator<T>;

Defined in: typescript:

Returns an iterable of values in the array

Returns

ArrayIterator<T>

Inherited from

Array.values

Properties

[unscopables]

readonly [unscopables]: {
[key: number]: boolean | undefined;
  [iterator]?: boolean;
  [unscopables]?: boolean;
  at?: boolean;
  concat?: boolean;
  copyWithin?: boolean;
  entries?: boolean;
  every?: boolean;
  fill?: boolean;
  filter?: boolean;
  find?: boolean;
  findIndex?: boolean;
  flat?: boolean;
  flatMap?: boolean;
  forEach?: boolean;
  includes?: boolean;
  indexOf?: boolean;
  join?: boolean;
  keys?: boolean;
  lastIndexOf?: boolean;
  length?: boolean;
  map?: boolean;
  pop?: boolean;
  push?: boolean;
  reduce?: boolean;
  reduceRight?: boolean;
  reverse?: boolean;
  shift?: boolean;
  slice?: boolean;
  some?: boolean;
  sort?: boolean;
  splice?: boolean;
  toLocaleString?: boolean;
  toString?: boolean;
  unshift?: boolean;
  values?: boolean;
};

Defined in: typescript:

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Index Signature

[key: number]: boolean | undefined

Name	Type	Description	Defined in
[iterator]?	boolean	-	typescript:
[unscopables]?	boolean	Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.	typescript:
at?	boolean	-	typescript:
concat?	boolean	-	typescript:
copyWithin?	boolean	-	typescript:
entries?	boolean	-	typescript:
every?	boolean	-	typescript:
fill?	boolean	-	typescript:
filter?	boolean	-	typescript:
find?	boolean	-	typescript:
findIndex?	boolean	-	typescript:
flat?	boolean	-	typescript:
flatMap?	boolean	-	typescript:
forEach?	boolean	-	typescript:
includes?	boolean	-	typescript:
indexOf?	boolean	-	typescript:
join?	boolean	-	typescript:
keys?	boolean	-	typescript:
lastIndexOf?	boolean	-	typescript:
length?	boolean	Gets or sets the length of the array. This is a number one higher than the highest index in the array.	typescript:
map?	boolean	-	typescript:
pop?	boolean	-	typescript:
push?	boolean	-	typescript:
reduce?	boolean	-	typescript:
reduceRight?	boolean	-	typescript:
reverse?	boolean	-	typescript:
shift?	boolean	-	typescript:
slice?	boolean	-	typescript:
some?	boolean	-	typescript:
sort?	boolean	-	typescript:
splice?	boolean	-	typescript:
toLocaleString?	boolean	-	typescript:
toString?	boolean	-	typescript:
unshift?	boolean	-	typescript:
values?	boolean	-	typescript:

Inherited from

Array.[unscopables]

---

length

length: number;

Defined in: typescript:

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

Array.length