Interface Uint16Array
Hierarchy
- Uint16Array
Indexable
A typed array of 16-bit unsigned integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised.
Index
Properties
BYTES_PER_ELEMENT
The size in bytes of each element in the array.
buffer
The ArrayBuffer instance referenced by the array.
byteLength
The length in bytes of the array.
byteOffset
The offset in bytes of the array.
length
The length of the array.
Methods
copyWithin
-
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
Parameters
-
target: number
If target is negative, it is treated as length+target where length is the length of the array.
-
start: number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
-
Optional end: number
If not specified, length of the this object is used as its default value.
Returns this
-
every
-
Determines whether all the members of an array satisfy the specified test.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint16Array
Returns boolean
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
fill
-
Returns the this object after filling the section identified by start and end with value
Parameters
-
value: number
value to fill array section with
-
Optional start: number
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.
-
Optional end: number
index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this
-
filter
-
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint16Array
Returns any
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Uint16Array
-
find
-
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
-
predicate: function
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.
-
-
Parameters
-
value: number
-
index: number
-
obj: Uint16Array
Returns boolean
-
-
-
-
Optional thisArg: any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number | undefined
-
findIndex
-
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
-
predicate: function
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.
-
-
Parameters
-
value: number
-
index: number
-
obj: Uint16Array
Returns boolean
-
-
-
-
Optional thisArg: any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
-
forEach
-
Performs the specified action for each element in an array.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint16Array
Returns void
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
-
indexOf
-
Returns the index of the first occurrence of a value in an array.
Parameters
-
searchElement: number
The value to locate in the array.
-
Optional fromIndex: number
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
-
join
-
Adds all the elements of an array separated by the specified separator string.
Parameters
-
Optional separator: string
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.
Returns string
-
lastIndexOf
-
Returns the index of the last occurrence of a value in an array.
Parameters
-
searchElement: number
The value to locate in the array.
-
Optional fromIndex: number
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
-
map
-
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint16Array
Returns number
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Uint16Array
-
reduce
-
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.
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns number
-
-
-
Returns number
-
-
Parameters
-
callbackfn: function
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns number
-
-
-
-
initialValue: number
Returns number
-
-
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.
Type parameters
-
U
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: U
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns U
-
-
-
-
initialValue: U
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.
Returns U
-
reduceRight
-
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.
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns number
-
-
-
Returns number
-
-
Parameters
-
callbackfn: function
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns number
-
-
-
-
initialValue: number
Returns number
-
-
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.
Type parameters
-
U
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: U
-
currentValue: number
-
currentIndex: number
-
array: Uint16Array
Returns U
-
-
-
-
initialValue: U
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.
Returns U
-
reverse
-
Reverses the elements in an Array.
Returns Uint16Array
set
-
Sets a value or an array of values.
Parameters
-
array: ArrayLike<number>
A typed or untyped array of values to set.
-
Optional offset: number
The index in the current array at which the values are to be written.
Returns void
-
slice
-
Returns a section of an array.
Parameters
-
Optional start: number
The beginning of the specified portion of the array.
-
Optional end: number
The end of the specified portion of the array.
Returns Uint16Array
-
some
-
Determines whether the specified callback function returns true for any element of an array.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint16Array
Returns boolean
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
sort
-
Sorts an array.
Parameters
-
Optional compareFn: function
The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
-
-
Parameters
-
a: number
-
b: number
Returns number
-
-
-
Returns this
-
subarray
-
Gets a new Uint16Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
-
begin: number
The index of the beginning of the array.
-
Optional end: number
The index of the end of the array.
Returns Uint16Array
-
toLocaleString
-
Converts a number to a string by using the current locale.
Returns string
toString
-
Returns a string representation of an array.
Returns string
Generated using TypeDoc
A typed array of 16-bit unsigned integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised.