kotlin-js/js.typedarrays/TypedArray

TypedArray

sealed external class TypedArray<S : TypedArray<S, R, B, T>, R : TypedArray<R, R, ArrayBuffer, T>, B : ArrayBufferLike, T : Comparable<T>> : ArrayBufferView<B> , MutableArrayLike<T> , ListLike<T> (source)

Inheritors

Properties

buffer

abstract val buffer: B

byteLength

open override val byteLength: Int

byteOffset

abstract val byteOffset: Int

BYTES_PER_ELEMENT

val BYTES_PER_ELEMENT: Int

The size in bytes of each element in the array.

length

abstract val length: Int

Functions

asList

fun <T> ArrayLike<T>.asList(): List<T>

fun at(index: Int): T?

Returns the item located at the specified index.

copyWithin

fun copyWithin(target: Int, start: Int, end: Int = definedExternally): S

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

entries

open override fun entries(): JsIterator<JsTuple2<Int, T>>

every

fun every(predicate: (value: T) -> Unit): Boolean

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

fill

fun fill(value: T, start: Int = definedExternally, end: Int = definedExternally): S

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

filter

fun filter(predicate: (value: T) -> Boolean): R

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

find

fun find(predicate: (value: T) -> Boolean): T?

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

findIndex

fun findIndex(predicate: (value: T) -> Boolean): Int

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

findLast

fun findLast(predicate: (value: T) -> Boolean): T?

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

findLastIndex

fun findLastIndex(predicate: (value: T) -> Boolean): Int

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

forEach

open override fun forEach(action: (item: T) -> Unit)

Performs the specified action for each element in an array.

get

open operator fun get(index: Int): T

open operator fun get(key: Symbol.iterator): () -> JsIterator<T>

includes

fun includes(searchElement: T, fromIndex: Int = definedExternally): Boolean

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

indexOf

fun indexOf(searchElement: T, fromIndex: Int = definedExternally): Int

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

iterator

open inline operator fun iterator(): Iterator<T>

join

fun join(separator: String = definedExternally): String

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

keys

open override fun keys(): JsIterator<Int>

lastIndexOf

fun lastIndexOf(searchElement: T, fromIndex: Int = definedExternally): Int

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

map

fun map(transform: (value: T) -> T): R

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

reverse

fun reverse(): S

Reverses the elements in an Array.

set

open operator fun set(index: Int, value: T)

fun set(array: S, offset: Int = definedExternally)

fun set(array: ReadonlyArray<T>, offset: Int = definedExternally)

slice

fun slice(start: Int = definedExternally, end: Int = definedExternally): R

Returns a section of an array.

some

fun some(predicate: (value: T) -> Boolean): Boolean

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

sort

fun sort(comparison: (a: T, b: T) -> Int = definedExternally): S

Sorts an array.

subarray

fun subarray(start: Int, end: Int): S

toLocaleString

fun toLocaleString(): String

Converts a number to a string by using the current locale.

toReversed

fun toReversed(): R

Copies the array and returns the copy with the elements in reverse order.

toSorted

fun toSorted(comparison: (a: T, b: T) -> Int = definedExternally): R

Copies and sorts the array.

valueOf

fun valueOf(): S

Returns the primitive value of the specified object.

values

open override fun values(): JsIterator<T>

with

fun with(index: Int, value: T): R

Copies the array and inserts the given number at the provided index.