kotlin-js/js.typedarrays/Uint8Array

Uint8Array

open external class Uint8Array(val buffer: B, val byteOffset: Int = definedExternally, val length: Int = definedExternally) : TypedArray<Uint8Array, Uint8Array<ArrayBuffer>, B, Byte> (source)

Constructors

Uint8Array

constructor()

constructor(length: Int)

constructor(elements: JsIterable<Byte>)

constructor(elements: ReadonlyArray<Byte>)

constructor(buffer: B, byteOffset: Int = definedExternally, length: Int = definedExternally)

Types

Companion

object Companion : TypedArrayCompanion<Uint8Array<ArrayBuffer>, Byte>

Properties

buffer

open override val buffer: B

byteLength

open override val byteLength: Int

byteOffset

open override val byteOffset: Int

BYTES_PER_ELEMENT

val BYTES_PER_ELEMENT: Int

The size in bytes of each element in the array.

length

open override val length: Int

Functions

asList

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

fun at(index: Int): Byte?

Returns the item located at the specified index.

copyWithin

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

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, Byte>>

every

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

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

fill

fun fill(value: Byte, start: Int = definedExternally, end: Int = definedExternally): Uint8Array

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

filter

fun filter(predicate: (value: Byte) -> Boolean): Uint8Array<ArrayBuffer>

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

find

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

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

findIndex

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

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

findLast

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

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

findLastIndex

fun findLastIndex(predicate: (value: Byte) -> 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: Byte) -> Unit)

Performs the specified action for each element in an array.

get

open operator fun get(index: Int): Byte

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

includes

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

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

indexOf

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

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

iterator

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

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: Byte, fromIndex: Int = definedExternally): Int

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

map

fun map(transform: (value: Byte) -> Byte): Uint8Array<ArrayBuffer>

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

reverse

fun reverse(): Uint8Array

Reverses the elements in an Array.

set

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

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

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

slice

fun slice(start: Int = definedExternally, end: Int = definedExternally): Uint8Array<ArrayBuffer>

Returns a section of an array.

some

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

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

sort

fun sort(comparison: (a: Byte, b: Byte) -> Int = definedExternally): Uint8Array

Sorts an array.

subarray

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

toByteArray

inline fun toByteArray(): ByteArray

toLocaleString

fun toLocaleString(): String

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

toReversed

fun toReversed(): Uint8Array<ArrayBuffer>

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

toSorted

fun toSorted(comparison: (a: Byte, b: Byte) -> Int = definedExternally): Uint8Array<ArrayBuffer>

Copies and sorts the array.

toUByteArray

inline fun toUByteArray(): UByteArray

valueOf

fun valueOf(): Uint8Array

Returns the primitive value of the specified object.

values

open override fun values(): JsIterator<Byte>

with

fun with(index: Int, value: Byte): Uint8Array<ArrayBuffer>

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