Kotlin Wrappers API Reference

kotlin-js/js.typedarrays/TypedArray

TypedArray

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

Inheritors

Uint8ClampedArray

Properties

abstract val buffer: B

open override val byteLength: Int

abstract val byteOffset: Int

BYTES_PER_ELEMENT

val BYTES_PER_ELEMENT: Int

The size in bytes of each element in the array.

abstract val length: Int

Functions

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

fun at(index: Int): T?

Returns the item located at the specified index.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Performs the specified action for each element in an array.

open operator fun get(index: Int): T

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

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

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

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

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

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

fun join(separator: String = definedExternally): String

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

open override fun keys(): JsIterator<JsInt>

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

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

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.

fun reduce(operation: (previousValue: T, currentValue: T, currentIndex: Int) -> T): T

fun <U : JsAny?> reduce(operation: (previousValue: U, currentValue: T, currentIndex: Int) -> 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.

fun reduceRight(operation: (previousValue: T, currentValue: T, currentIndex: Int) -> T): T

fun <U : JsAny?> reduceRight(operation: (previousValue: U, currentValue: T, currentIndex: Int) -> 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.

fun reverse(): S

Reverses the elements in an Array.

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

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

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

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

Returns a section of an array.

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

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

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

Sorts an array.

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

fun toLocaleString(): String

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

fun toReversed(): R

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

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

Copies and sorts the array.

fun valueOf(): S

Returns the primitive value of the specified object.

open override fun values(): JsIterator<T>

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

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