ReadonlyArray

@native @JSType trait ReadonlyArray[T] extends StObject with NumberDictionary[T]
trait NumberDictionary[T]
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

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

Combines two or more arrays.

Combines two or more arrays.

Value Params
items

Additional items to add to the end of array1.

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

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.

def every(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Boolean
@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.

@JSName("every")
def every_S_T[S](predicate: Function3[T, Double, Array[T], Boolean], thisArg: Any): Boolean
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.

def filter(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Array[T]
@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.

@JSName("filter")
def filter_S_T[S](predicate: Function3[T, Double, Array[T], Boolean], thisArg: Any): Array[S]
def find(predicate: Function3[T, Double, Array[T], Any]): UndefOr[T]
def find(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): UndefOr[T]
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.

def find[S](predicate: ThisFunction3[Unit, T, Double, Array[T], Boolean], thisArg: Any): UndefOr[S]
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.

def findIndex(predicate: Function3[T, Double, Array[T], Any], thisArg: Any): Double
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

def flat[A, D](depth: D): Array[FlatArray[A, D]]
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.

def flatMap[U, This](callback: ThisFunction3[This, T, Double, Array[T], U | Array[U]], thisArg: This): Array[U]
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.

def forEach(callbackfn: Function3[T, Double, Array[T], Unit], thisArg: Any): Unit
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.

def includes(searchElement: T, fromIndex: Double): Boolean
def indexOf(searchElement: T): Double

Returns the index of the first occurrence of a value in an array.

Returns the index of the first occurrence of a value in an array.

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.

def indexOf(searchElement: T, fromIndex: Double): Double
def join(): String

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

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

Value Params
separator

A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

def join(separator: String): String
def keys(): IterableIterator[Double]

Returns an iterable of keys in the array

Returns an iterable of keys in the array

def lastIndexOf(searchElement: T): Double

Returns the index of the last occurrence of a specified value in an array.

Returns the index of the last occurrence of a specified value in an array.

Value Params
fromIndex

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

searchElement

The value to locate in the array.

def lastIndexOf(searchElement: T, fromIndex: Double): Double
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.

def map[U](callbackfn: Function3[T, Double, Array[T], U], thisArg: Any): Array[U]
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.

def reduce(callbackfn: Function4[T, T, Double, Array[T], T], initialValue: T): T
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.

def reduceRight(callbackfn: Function4[T, T, Double, Array[T], T], initialValue: T): T
@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.

@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.

def slice(): Array[T]

Returns a section of an array.

Returns a section of an array.

Value Params
end

The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

start

The beginning of the specified portion of the array.

def slice(start: Double): Array[T]
def slice(start: Double, end: Double): Array[T]
def slice(start: Unit, end: Double): Array[T]
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.

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

Returns an iterable of values in the array

Returns an iterable of values in the array

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object

Concrete fields

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

Iterator of values in the array.

Iterator of values in the array.

val length: Double

Gets the length of the array. This is a number one higher than the highest element defined in an array.

Gets the length of the array. This is a number one higher than the highest element defined in an array.