Array

@JSGlobal("Array") @native @JSType class Array[T] extends StObject with Array[T]
Companion
object
trait Array[T]
trait NumberDictionary[T]
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Constructors

def this(arrayLength: Double)
def this(items: T*)

Inherited methods

def concat(items: Array[T] | T*): Array[T]

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

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

Value Params
items

Additional arrays and/or items to add to the end of the array.

Inherited from
Array
def copyWithin(target: Double, start: Double, end: Double): Array[T]
Inherited from
Array
def copyWithin(target: Double, start: Double): Array[T]

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

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

Value Params
end

If not specified, length of the this object is used as its default value.

start

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

target

If target is negative, it is treated as length+target where length is the length of the array.

Inherited from
Array
def entries(): IterableIterator[Tuple2[Double, T]]

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

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

Inherited from
Array
def every(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Boolean
Inherited from
Array
def every(predicate: Function3[T, Double, Array[T], Any]): Boolean

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

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

Value Params
predicate

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

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
@JSName("every")
def every_S_T[S](predicate: Function3[T, Double, Array[T], Boolean], thisArg: Any): Boolean
Inherited from
Array
@JSName("every")
def every_S_T[S](predicate: Function3[T, Double, Array[T], Boolean]): Boolean

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

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

Value Params
predicate

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

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def fill(value: T, start: Unit, end: Double): Array[T]
Inherited from
Array
def fill(value: T, start: Double, end: Double): Array[T]
Inherited from
Array
def fill(value: T, start: Double): Array[T]
Inherited from
Array
def fill(value: T): Array[T]

Returns the this object after filling the section identified by start and end with value

Returns the this object after filling the section identified by start and end with value

Value Params
end

index to stop filling the array at. If end is negative, it is treated as length+end.

start

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.

value

value to fill array section with

Inherited from
Array
def filter(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Array[T]
Inherited from
Array
def filter(predicate: Function3[T, Double, Array[T], Any]): Array[T]

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

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

Value Params
predicate

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
@JSName("filter")
def filter_S_T[S](predicate: Function3[T, Double, Array[T], Boolean], thisArg: Any): Array[S]
Inherited from
Array
@JSName("filter")
def filter_S_T[S](predicate: Function3[T, Double, Array[T], Boolean]): Array[S]

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

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

Value Params
predicate

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def find[S](predicate: ThisFunction3[Unit, T, Double, Array[T], Boolean], thisArg: Any): UndefOr[S]
Inherited from
Array
def find[S](predicate: ThisFunction3[Unit, T, Double, Array[T], Boolean]): UndefOr[S]

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

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

Value Params
predicate

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

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Inherited from
Array
def find(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): UndefOr[T]
Inherited from
Array
def find(predicate: Function3[T, Double, Array[T], Any]): UndefOr[T]
Inherited from
Array
def findIndex(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Double
Inherited from
Array
def findIndex(predicate: Function3[T, Double, Array[T], Any]): Double

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

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

Value Params
predicate

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

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Inherited from
Array
def flat[A, D](depth: D): Array[FlatArray[A, D]]
Inherited from
Array
def flat[A, D](): Array[FlatArray[A, D]]

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

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

Value Params
depth

The maximum recursion depth

Inherited from
Array
def flatMap[U, This](callback: ThisFunction3[This, T, Double, Array[T], U | Array[U]], thisArg: This): Array[U]
Inherited from
Array
def flatMap[U, This](callback: ThisFunction3[This, T, Double, Array[T], U | Array[U]]): Array[U]

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.

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.

Value Params
callback

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def forEach(callbackfn: Function3[T, Double, Array[T], Unit], thisArg: Any): Unit
Inherited from
Array
def forEach(callbackfn: Function3[T, Double, Array[T], Unit]): Unit

Performs the specified action for each element in an array.

Performs the specified action for each element in an array.

Value Params
callbackfn

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def hasOwnProperty(v: String): Boolean
Inherited from
Object
def includes(searchElement: T, fromIndex: Double): Boolean
Inherited from
Array
def includes(searchElement: T): Boolean

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

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

Value Params
fromIndex

The position in this array at which to begin searching for searchElement.

searchElement

The element to search for.

Inherited from
Array
def indexOf(searchElement: T, fromIndex: Double): Double
Inherited from
Array
def indexOf(searchElement: T): Double

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

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

Value Params
fromIndex

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

searchElement

The value to locate in the array.

Inherited from
Array
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def join(separator: String): String
Inherited from
Array
def join(): String

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

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

Value Params
separator

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.

Inherited from
Array
def keys(): IterableIterator[Double]

Returns an iterable of keys in the array

Returns an iterable of keys in the array

Inherited from
Array
def lastIndexOf(searchElement: T, fromIndex: Double): Double
Inherited from
Array
def lastIndexOf(searchElement: T): Double

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

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

Value Params
fromIndex

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

searchElement

The value to locate in the array.

Inherited from
Array
def map[U](callbackfn: Function3[T, Double, Array[T], U], thisArg: Any): Array[U]
Inherited from
Array
def map[U](callbackfn: Function3[T, Double, Array[T], U]): Array[U]

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

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

Value Params
callbackfn

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def pop(): UndefOr[T]

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

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

Inherited from
Array
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def push(items: T*): Double

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

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

Value Params
items

New elements to add to the array.

Inherited from
Array
def reduce(callbackfn: Function4[T, T, Double, Array[T], T], initialValue: T): T
Inherited from
Array
def reduce(callbackfn: Function4[T, T, Double, Array[T], T]): T

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.

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.

Value Params
callbackfn

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

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.

Inherited from
Array
def reduceRight(callbackfn: Function4[T, T, Double, Array[T], T], initialValue: T): T
Inherited from
Array
def reduceRight(callbackfn: Function4[T, T, Double, Array[T], T]): T

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.

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.

Value Params
callbackfn

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

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.

Inherited from
Array
@JSName("reduceRight")
def reduceRight_U_U[U](callbackfn: Function4[U, T, Double, Array[T], U], initialValue: U): U

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.

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.

Value Params
callbackfn

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

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.

Inherited from
Array
@JSName("reduce")
def reduce_U_U[U](callbackfn: Function4[U, T, Double, Array[T], U], initialValue: U): U

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.

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.

Value Params
callbackfn

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

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.

Inherited from
Array
def reverse(): Array[T]

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

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

Inherited from
Array
def shift(): UndefOr[T]

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

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

Inherited from
Array
def slice(start: Unit, end: Double): Array[T]
Inherited from
Array
def slice(start: Double, end: Double): Array[T]
Inherited from
Array
def slice(start: Double): Array[T]
Inherited from
Array
def slice(): Array[T]

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.

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.

Value Params
end

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.

start

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

Inherited from
Array
def some(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Boolean
Inherited from
Array
def some(predicate: Function3[T, Double, Array[T], Any]): Boolean

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

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

Value Params
predicate

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

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Inherited from
Array
def sort(compareFn: Function2[T, T, Double]): Array[T]
Inherited from
Array
def sort(): Array[T]

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

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

Value Params
compareFn

Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

[11,2,22,1].sort((a, b) => a - b)
Inherited from
Array
def splice(start: Double, deleteCount: Double, items: T*): Array[T]

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

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

Value Params
deleteCount

The number of elements to remove.

items

Elements to insert into the array in place of the deleted elements.

start

The zero-based location in the array from which to start removing elements.

Inherited from
Array
def splice(start: Double, deleteCount: Double): Array[T]
Inherited from
Array
def splice(start: Double): Array[T]

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

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

Value Params
deleteCount

The number of elements to remove.

start

The zero-based location in the array from which to start removing elements.

Inherited from
Array
def toLocaleString(): String
Inherited from
Object
def unshift(items: T*): Double

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

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

Value Params
items

Elements to insert at the start of the array.

Inherited from
Array
def valueOf(): Any
Inherited from
Object

Returns an iterable of values in the array

Returns an iterable of values in the array

Inherited from
Array

Inherited fields

@JSName
var iterator: Function0[IterableIterator[T]]

Iterator

Iterator

Inherited from
Array
var length: Double

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

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

Inherited from
Array
@JSName
var unscopables: Function0[CopyWithin]

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

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

Inherited from
Array