22 Indexed Collections
22.1 Array Objects
Array objects are exotic objects that give special treatment to a certain class of property names. See
22.1.1 The Array Constructor
The Array
- is the intrinsic object
%Array% . - is the initial value of the
"Array" property of theglobal object . - creates and initializes a new
Array exotic object when called as aconstructor . - also creates and initializes a new Array object when called as a function rather than as a
constructor . Thus the function callArray(…)is equivalent to the object creation expressionnew Array(…)with the same arguments. - is a single function whose behaviour is overloaded based upon the number and types of its arguments.
- is designed to be subclassable. It may be used as the value of an
extendsclause of a class definition. Subclass constructors that intend to inherit the exoticArraybehaviour must include asupercall to theArrayconstructor to initialize subclass instances that are Array exotic objects. However, most of theArray.prototypemethods are generic methods that are not dependent upon theirthis value being anArray exotic object . - has a
"length" property whose value is 1.
22.1.1.1 Array ( )
This description applies if and only if the Array
- Let numberOfArgs be the number of arguments passed to this function call.
Assert : numberOfArgs = 0.- If NewTarget is
undefined , let newTarget be theactive function object ; else let newTarget be NewTarget. - Let proto be ?
GetPrototypeFromConstructor (newTarget," ).%Array.prototype% " - Return !
ArrayCreate (0, proto).
22.1.1.2 Array ( len )
This description applies if and only if the Array
- Let numberOfArgs be the number of arguments passed to this function call.
Assert : numberOfArgs = 1.- If NewTarget is
undefined , let newTarget be theactive function object ; else let newTarget be NewTarget. - Let proto be ?
GetPrototypeFromConstructor (newTarget," ).%Array.prototype% " - Let array be !
ArrayCreate (0, proto). - If
Type (len) is not Number, then- Perform !
CreateDataPropertyOrThrow (array,"0" , len). - Let intLen be 1.
- Perform !
- Else,
- Let intLen be
ToUint32 (len). - If intLen ≠ len, throw a
RangeError exception.
- Let intLen be
- Perform !
Set (array,"length" , intLen,true ). - Return array.
22.1.1.3 Array ( ...items )
This description applies if and only if the Array
When the Array function is called, the following steps are taken:
- Let numberOfArgs be the number of arguments passed to this function call.
Assert : numberOfArgs ≥ 2.- If NewTarget is
undefined , let newTarget be theactive function object ; else let newTarget be NewTarget. - Let proto be ?
GetPrototypeFromConstructor (newTarget," ).%Array.prototype% " - Let array be ?
ArrayCreate (numberOfArgs, proto). - Let k be 0.
- Let items be a zero-origined
List containing the argument items in order. - Repeat, while k < numberOfArgs
- Let Pk be !
ToString (k). - Let itemK be items[k].
- Perform !
CreateDataPropertyOrThrow (array, Pk, itemK). Set k to k + 1.
- Let Pk be !
Assert : The value of array's"length" property is numberOfArgs.- Return array.
22.1.2 Properties of the Array Constructor
The Array
- has a [[Prototype]] internal slot whose value is
%Function.prototype% . - has the following properties:
22.1.2.1 Array.from ( items [ , mapfn [ , thisArg ] ] )
When the from method is called with argument items and optional arguments mapfn and thisArg, the following steps are taken:
- Let C be the
this value. - If mapfn is
undefined , let mapping befalse . - Else,
- If
IsCallable (mapfn) isfalse , throw aTypeError exception. - Let mapping be
true .
- If
- Let usingIterator be ?
GetMethod (items, @@iterator). - If usingIterator is not
undefined , then- If
IsConstructor (C) istrue , then- Let A be ?
Construct (C).
- Let A be ?
- Else,
- Let A be !
ArrayCreate (0).
- Let A be !
- Let iteratorRecord be ?
GetIterator (items,sync , usingIterator). - Let k be 0.
- Repeat,
- If k ≥ 253 - 1, then
- Let error be
ThrowCompletion (a newly createdTypeError object). - Return ?
IteratorClose (iteratorRecord, error).
- Let error be
- Let Pk be !
ToString (k). - Let next be ?
IteratorStep (iteratorRecord). - If next is
false , then- Perform ?
Set (A,"length" , k,true ). - Return A.
- Perform ?
- Let nextValue be ?
IteratorValue (next). - If mapping is
true , then- Let mappedValue be
Call (mapfn, thisArg, « nextValue, k »). - If mappedValue is an
abrupt completion , return ?IteratorClose (iteratorRecord, mappedValue). Set mappedValue to mappedValue.[[Value]].
- Let mappedValue be
- Else, let mappedValue be nextValue.
- Let defineStatus be
CreateDataPropertyOrThrow (A, Pk, mappedValue). - If defineStatus is an
abrupt completion , return ?IteratorClose (iteratorRecord, defineStatus). Set k to k + 1.
- If k ≥ 253 - 1, then
- If
- NOTE: items is not an Iterable so assume it is an
array-like object . - Let arrayLike be !
ToObject (items). - Let len be ?
LengthOfArrayLike (arrayLike). - If
IsConstructor (C) istrue , then- Let A be ?
Construct (C, « len »).
- Let A be ?
- Else,
- Let A be ?
ArrayCreate (len).
- Let A be ?
- Let k be 0.
- Repeat, while k < len
- Let Pk be !
ToString (k). - Let kValue be ?
Get (arrayLike, Pk). - If mapping is
true , then- Let mappedValue be ?
Call (mapfn, thisArg, « kValue, k »).
- Let mappedValue be ?
- Else, let mappedValue be kValue.
- Perform ?
CreateDataPropertyOrThrow (A, Pk, mappedValue). Set k to k + 1.
- Let Pk be !
- Perform ?
Set (A,"length" , len,true ). - Return A.
The from function is an intentionally generic factory method; it does not require that its
22.1.2.2 Array.isArray ( arg )
The isArray function takes one argument arg, and performs the following steps:
- Return ?
IsArray (arg).
22.1.2.3 Array.of ( ...items )
When the of method is called with any number of arguments, the following steps are taken:
- Let len be the actual number of arguments passed to this function.
- Let items be the
List of arguments passed to this function. - Let C be the
this value. - If
IsConstructor (C) istrue , then- Let A be ?
Construct (C, « len »).
- Let A be ?
- Else,
- Let A be ?
ArrayCreate (len).
- Let A be ?
- Let k be 0.
- Repeat, while k < len
- Let kValue be items[k].
- Let Pk be !
ToString (k). - Perform ?
CreateDataPropertyOrThrow (A, Pk, kValue). Set k to k + 1.
- Perform ?
Set (A,"length" , len,true ). - Return A.
The items argument is assumed to be a well-formed rest argument value.
The of function is an intentionally generic factory method; it does not require that its
22.1.2.4 Array.prototype
The value of Array.prototype is
This property has the attributes { [[Writable]]:
22.1.2.5 get Array [ @@species ]
Array[@@species] is an
- Return the
this value.
The value of the
Array prototype methods normally use their
22.1.3 Properties of the Array Prototype Object
The Array prototype object:
- is the intrinsic object
%ArrayPrototype% . - is an
Array exotic object and has the internal methods specified for such objects. - has a
"length" property whose initial value is 0 and whose attributes are { [[Writable]]:true , [[Enumerable]]:false , [[Configurable]]:false }. - has a [[Prototype]] internal slot whose value is
%Object.prototype% .
The Array prototype object is specified to be an
22.1.3.1 Array.prototype.concat ( ...arguments )
When the concat method is called with zero or more arguments, it returns an array containing the array elements of the object followed by the array elements of each argument in order.
The following steps are taken:
- Let O be ?
ToObject (this value). - Let A be ?
ArraySpeciesCreate (O, 0). - Let n be 0.
- Let items be a
List whose first element is O and whose subsequent elements are, in left to right order, the arguments that were passed to this function invocation. - Repeat, while items is not empty
- Remove the first element from items and let E be the value of the element.
- Let spreadable be ?
IsConcatSpreadable (E). - If spreadable is
true , then- Let k be 0.
- Let len be ?
LengthOfArrayLike (E). - If n + len > 253 - 1, throw a
TypeError exception. - Repeat, while k < len
- Let P be !
ToString (k). - Let exists be ?
HasProperty (E, P). - If exists is
true , then- Let subElement be ?
Get (E, P). - Perform ?
CreateDataPropertyOrThrow (A, !ToString (n), subElement).
- Let subElement be ?
Set n to n + 1.Set k to k + 1.
- Let P be !
- Else,
- NOTE: E is added as a single item rather than spread.
- If n ≥ 253 - 1, throw a
TypeError exception. - Perform ?
CreateDataPropertyOrThrow (A, !ToString (n), E). Set n to n + 1.
- Perform ?
Set (A,"length" , n,true ). - Return A.
The concat method is 1.
The explicit setting of the
The concat function is intentionally generic; it does not require that its
22.1.3.1.1 Runtime Semantics: IsConcatSpreadable ( O )
22.1.3.2 Array.prototype.constructor
The initial value of Array.prototype.constructor is
22.1.3.3 Array.prototype.copyWithin ( target, start [ , end ] )
The copyWithin method takes up to three arguments target, start and end.
The end argument is optional with the length of the
The following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let relativeTarget be ?
ToInteger (target). - If relativeTarget < 0, let to be
max ((len + relativeTarget), 0); else let to bemin (relativeTarget, len). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let from be
max ((len + relativeStart), 0); else let from bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - Let count be
min (final - from, len - to). - If from < to and to < from + count, then
- Else,
- Let direction be 1.
- Repeat, while count > 0
- Let fromKey be !
ToString (from). - Let toKey be !
ToString (to). - Let fromPresent be ?
HasProperty (O, fromKey). - If fromPresent is
true , then - Else,
Assert : fromPresent isfalse .- Perform ?
DeletePropertyOrThrow (O, toKey).
Set from to from + direction.Set to to to + direction.Set count to count - 1.
- Let fromKey be !
- Return O.
The copyWithin function is intentionally generic; it does not require that its
22.1.3.4 Array.prototype.entries ( )
The following steps are taken:
- Let O be ?
ToObject (this value). - Return
CreateArrayIterator (O,key+value ).
This function is the %ArrayProto_entries% intrinsic object.
22.1.3.5 Array.prototype.every ( callbackfn [ , thisArg ] )
callbackfn should be a function that accepts three arguments and returns a value that is coercible to the Boolean value every calls callbackfn once for each element present in the array, in ascending order, until it finds one where callbackfn returns every immediately returns every will return
If a thisArg parameter is provided, it will be used as the
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
every does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by every is set before the first call to callbackfn. Elements which are appended to the array after the call to every begins will not be visited by callbackfn. If existing elements of the array are changed, their value as passed to callbackfn will be the value at the time every visits them; elements that are deleted after the call to every begins and before being visited are not visited. every acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns
When the every method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let k be 0.
- Repeat, while k < len
- Return
true .
The every function is intentionally generic; it does not require that its
22.1.3.6 Array.prototype.fill ( value [ , start [ , end ] ] )
The fill method takes up to three arguments value, start and end.
The start and end arguments are optional with default values of 0 and the length of the
The following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let k be
max ((len + relativeStart), 0); else let k bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - Repeat, while k < final
- Return O.
The fill function is intentionally generic; it does not require that its
22.1.3.7 Array.prototype.filter ( callbackfn [ , thisArg ] )
callbackfn should be a function that accepts three arguments and returns a value that is coercible to the Boolean value filter calls callbackfn once for each element in the array, in ascending order, and constructs a new array of all the values for which callbackfn returns
If a thisArg parameter is provided, it will be used as the
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
filter does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by filter is set before the first call to callbackfn. Elements which are appended to the array after the call to filter begins will not be visited by callbackfn. If existing elements of the array are changed their value as passed to callbackfn will be the value at the time filter visits them; elements that are deleted after the call to filter begins and before being visited are not visited.
When the filter method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let A be ?
ArraySpeciesCreate (O, 0). - Let k be 0.
- Let to be 0.
- Repeat, while k < len
- Let Pk be !
ToString (k). - Let kPresent be ?
HasProperty (O, Pk). - If kPresent is
true , then Set k to k + 1.
- Let Pk be !
- Return A.
The filter function is intentionally generic; it does not require that its
22.1.3.8 Array.prototype.find ( predicate [ , thisArg ] )
The find method is called with one or two arguments, predicate and thisArg.
predicate should be a function that accepts three arguments and returns a value that is coercible to a Boolean value. find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns find immediately returns that element value. Otherwise, find returns
If a thisArg parameter is provided, it will be used as the
predicate is called with three arguments: the value of the element, the index of the element, and the object being traversed.
find does not directly mutate the object on which it is called but the object may be mutated by the calls to predicate.
The range of elements processed by find is set before the first call to predicate. Elements that are appended to the array after the call to find begins will not be visited by predicate. If existing elements of the array are changed, their value as passed to predicate will be the value at the time that find visits them.
When the find method is called, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (predicate) isfalse , throw aTypeError exception. - Let k be 0.
- Repeat, while k < len
- Return
undefined .
The find function is intentionally generic; it does not require that its
22.1.3.9 Array.prototype.findIndex ( predicate [ , thisArg ] )
predicate should be a function that accepts three arguments and returns a value that is coercible to the Boolean value findIndex calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns findIndex immediately returns the index of that element value. Otherwise, findIndex returns -1.
If a thisArg parameter is provided, it will be used as the
predicate is called with three arguments: the value of the element, the index of the element, and the object being traversed.
findIndex does not directly mutate the object on which it is called but the object may be mutated by the calls to predicate.
The range of elements processed by findIndex is set before the first call to predicate. Elements that are appended to the array after the call to findIndex begins will not be visited by predicate. If existing elements of the array are changed, their value as passed to predicate will be the value at the time that findIndex visits them.
When the findIndex method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (predicate) isfalse , throw aTypeError exception. - Let k be 0.
- Repeat, while k < len
- Return -1.
The findIndex function is intentionally generic; it does not require that its
22.1.3.10 Array.prototype.flat ( [ depth ] )
When the flat method is called with zero or one arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let sourceLen be ?
LengthOfArrayLike (O). - Let depthNum be 1.
- If depth is not
undefined , then - Let A be ?
ArraySpeciesCreate (O, 0). - Perform ?
FlattenIntoArray (A, O, sourceLen, 0, depthNum). - Return A.
22.1.3.10.1 FlattenIntoArray ( target, source, sourceLen, start, depth [ , mapperFunction, thisArg ] )
Assert :Type (target) is Object.Assert :Type (source) is Object.Assert : !IsNonNegativeInteger (sourceLen) istrue .Assert : !IsNonNegativeInteger (start) istrue .Assert : !IsInteger (depth) istrue , or depth is either+∞ or-∞ .Assert : If mapperFunction is present, then !IsCallable (mapperFunction) istrue , thisArg is present, and depth is1 .- Let targetIndex be start.
- Let sourceIndex be 0.
- Repeat, while sourceIndex < sourceLen
- Let P be !
ToString (sourceIndex). - Let exists be ?
HasProperty (source, P). - If exists is
true , then- Let element be ?
Get (source, P). - If mapperFunction is present, then
- Let shouldFlatten be
false . - If depth > 0, then
- If shouldFlatten is
true , then- Let elementLen be ?
LengthOfArrayLike (element). Set targetIndex to ? FlattenIntoArray(target, element, elementLen, targetIndex, depth - 1).
- Let elementLen be ?
- Else,
- If targetIndex ≥ 253 - 1, throw a
TypeError exception. - Perform ?
CreateDataPropertyOrThrow (target, !ToString (targetIndex), element). Set targetIndex to targetIndex + 1.
- If targetIndex ≥ 253 - 1, throw a
- Let element be ?
Set sourceIndex to sourceIndex + 1.
- Let P be !
- Return targetIndex.
22.1.3.11 Array.prototype.flatMap ( mapperFunction [ , thisArg ] )
When the flatMap method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let sourceLen be ?
LengthOfArrayLike (O). - If !
IsCallable (mapperFunction) isfalse , throw aTypeError exception. - Let A be ?
ArraySpeciesCreate (O, 0). - Perform ?
FlattenIntoArray (A, O, sourceLen, 0, 1, mapperFunction, thisArg). - Return A.
22.1.3.12 Array.prototype.forEach ( callbackfn [ , thisArg ] )
callbackfn should be a function that accepts three arguments. forEach calls callbackfn once for each element present in the array, in ascending order. callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If a thisArg parameter is provided, it will be used as the
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
forEach does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
When the forEach method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let k be 0.
- Repeat, while k < len
- Let Pk be !
ToString (k). - Let kPresent be ?
HasProperty (O, Pk). - If kPresent is
true , then Set k to k + 1.
- Let Pk be !
- Return
undefined .
This function is the %ArrayProto_forEach% intrinsic object.
The forEach function is intentionally generic; it does not require that its
22.1.3.13 Array.prototype.includes ( searchElement [ , fromIndex ] )
includes compares searchElement to the elements of the array, in ascending order, using the
The optional second argument fromIndex defaults to 0 (i.e. the whole array is searched). If it is greater than or equal to the length of the array,
When the includes method is called, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If len is 0, return
false . - Let n be ?
ToInteger (fromIndex). Assert : If fromIndex isundefined , then n is 0.- If n ≥ 0, then
- Let k be n.
- Else,
- Let k be len + n.
- If k < 0, set k to 0.
- Repeat, while k < len
- Let elementK be the result of ?
Get (O, !ToString (k)). - If
SameValueZero (searchElement, elementK) istrue , returntrue . Set k to k + 1.
- Let elementK be the result of ?
- Return
false .
The includes function is intentionally generic; it does not require that its
The includes method intentionally differs from the similar indexOf method in two ways. First, it uses the
22.1.3.14 Array.prototype.indexOf ( searchElement [ , fromIndex ] )
indexOf compares searchElement to the elements of the array, in ascending order, using the
The optional second argument fromIndex defaults to 0 (i.e. the whole array is searched). If it is greater than or equal to the length of the array, -1 is returned, i.e. the array will not be searched. If it is negative, it is used as the offset from the end of the array to compute fromIndex. If the computed index is less than 0, the whole array will be searched.
When the indexOf method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If len is 0, return -1.
- Let n be ?
ToInteger (fromIndex). Assert : If fromIndex isundefined , then n is 0.- If n ≥ len, return -1.
- If n ≥ 0, then
- Let k be n.
- Else,
- Let k be len + n.
- If k < 0, set k to 0.
- Repeat, while k < len
- Let kPresent be ?
HasProperty (O, !ToString (k)). - If kPresent is
true , then- Let elementK be ?
Get (O, !ToString (k)). - Let same be the result of performing
Strict Equality Comparison searchElement === elementK. - If same is
true , return k.
- Let elementK be ?
Set k to k + 1.
- Let kPresent be ?
- Return -1.
The indexOf function is intentionally generic; it does not require that its
22.1.3.15 Array.prototype.join ( separator )
The elements of the array are converted to Strings, and these Strings are then concatenated, separated by occurrences of the separator. If no separator is provided, a single comma is used as the separator.
The join method takes one argument, separator, and performs the following steps:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If separator is
undefined , let sep be the single-element String"," . - Else, let sep be ?
ToString (separator). - Let R be the empty String.
- Let k be 0.
- Repeat, while k < len
- If k > 0, set R to the
string-concatenation of R and sep. - Let element be ?
Get (O, !ToString (k)). - If element is
undefined ornull , let next be the empty String; otherwise, let next be ?ToString (element). Set R to thestring-concatenation of R and next.Set k to k + 1.
- If k > 0, set R to the
- Return R.
The join function is intentionally generic; it does not require that its
22.1.3.16 Array.prototype.keys ( )
The following steps are taken:
- Let O be ?
ToObject (this value). - Return
CreateArrayIterator (O,key ).
This function is the %ArrayProto_keys% intrinsic object.
22.1.3.17 Array.prototype.lastIndexOf ( searchElement [ , fromIndex ] )
lastIndexOf compares searchElement to the elements of the array in descending order using the
The optional second argument fromIndex defaults to the array's length minus one (i.e. the whole array is searched). If it is greater than or equal to the length of the array, the whole array will be searched. If it is negative, it is used as the offset from the end of the array to compute fromIndex. If the computed index is less than 0, -1 is returned.
When the lastIndexOf method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If len is 0, return -1.
- If fromIndex is present, let n be ?
ToInteger (fromIndex); else let n be len - 1. - If n ≥ 0, then
- Let k be
min (n, len - 1).
- Let k be
- Else,
- Let k be len + n.
- Repeat, while k ≥ 0
- Let kPresent be ?
HasProperty (O, !ToString (k)). - If kPresent is
true , then- Let elementK be ?
Get (O, !ToString (k)). - Let same be the result of performing
Strict Equality Comparison searchElement === elementK. - If same is
true , return k.
- Let elementK be ?
Set k to k - 1.
- Let kPresent be ?
- Return -1.
The lastIndexOf function is intentionally generic; it does not require that its
22.1.3.18 Array.prototype.map ( callbackfn [ , thisArg ] )
callbackfn should be a function that accepts three arguments. map calls callbackfn once for each element in the array, in ascending order, and constructs a new Array from the results. callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If a thisArg parameter is provided, it will be used as the
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
map does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by map is set before the first call to callbackfn. Elements which are appended to the array after the call to map begins will not be visited by callbackfn. If existing elements of the array are changed, their value as passed to callbackfn will be the value at the time map visits them; elements that are deleted after the call to map begins and before being visited are not visited.
When the map method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let A be ?
ArraySpeciesCreate (O, len). - Let k be 0.
- Repeat, while k < len
- Let Pk be !
ToString (k). - Let kPresent be ?
HasProperty (O, Pk). - If kPresent is
true , then- Let kValue be ?
Get (O, Pk). - Let mappedValue be ?
Call (callbackfn, thisArg, « kValue, k, O »). - Perform ?
CreateDataPropertyOrThrow (A, Pk, mappedValue).
- Let kValue be ?
Set k to k + 1.
- Let Pk be !
- Return A.
The map function is intentionally generic; it does not require that its
22.1.3.19 Array.prototype.pop ( )
The last element of the array is removed from the array and returned.
When the pop method is called, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If len is zero, then
- Perform ?
Set (O,"length" , 0,true ). - Return
undefined .
- Perform ?
- Else,
Assert : len > 0.- Let newLen be len - 1.
- Let index be !
ToString (newLen). - Let element be ?
Get (O, index). - Perform ?
DeletePropertyOrThrow (O, index). - Perform ?
Set (O,"length" , newLen,true ). - Return element.
The pop function is intentionally generic; it does not require that its
22.1.3.20 Array.prototype.push ( ...items )
The arguments are appended to the end of the array, in the order in which they appear. The new length of the array is returned as the result of the call.
When the push method is called with zero or more arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let items be a
List whose elements are, in left to right order, the arguments that were passed to this function invocation. - Let argCount be the number of elements in items.
- If len + argCount > 253 - 1, throw a
TypeError exception. - Repeat, while items is not empty
- Perform ?
Set (O,"length" , len,true ). - Return len.
The push method is 1.
The push function is intentionally generic; it does not require that its
22.1.3.21 Array.prototype.reduce ( callbackfn [ , initialValue ] )
callbackfn should be a function that takes four arguments. reduce calls the callback, as a function, once for each element after the first element present in the array, in ascending order.
callbackfn is called with four arguments: the previousValue (value from the previous call to callbackfn), the currentValue (value of the current element), the currentIndex, and the object being traversed. The first time that callback is called, the previousValue and currentValue can be one of two values. If an initialValue was supplied in the call to reduce, then previousValue will be equal to initialValue and currentValue will be equal to the first value in the array. If no initialValue was supplied, then previousValue will be equal to the first value in the array and currentValue will be equal to the second. It is a
reduce does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by reduce is set before the first call to callbackfn. Elements that are appended to the array after the call to reduce begins will not be visited by callbackfn. If existing elements of the array are changed, their value as passed to callbackfn will be the value at the time reduce visits them; elements that are deleted after the call to reduce begins and before being visited are not visited.
When the reduce method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - If len is 0 and initialValue is not present, throw a
TypeError exception. - Let k be 0.
- Let accumulator be
undefined . - If initialValue is present, then
Set accumulator to initialValue.
- Else,
- Repeat, while k < len
- Return accumulator.
The reduce function is intentionally generic; it does not require that its
22.1.3.22 Array.prototype.reduceRight ( callbackfn [ , initialValue ] )
callbackfn should be a function that takes four arguments. reduceRight calls the callback, as a function, once for each element after the first element present in the array, in descending order.
callbackfn is called with four arguments: the previousValue (value from the previous call to callbackfn), the currentValue (value of the current element), the currentIndex, and the object being traversed. The first time the function is called, the previousValue and currentValue can be one of two values. If an initialValue was supplied in the call to reduceRight, then previousValue will be equal to initialValue and currentValue will be equal to the last value in the array. If no initialValue was supplied, then previousValue will be equal to the last value in the array and currentValue will be equal to the second-to-last value. It is a
reduceRight does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by reduceRight is set before the first call to callbackfn. Elements that are appended to the array after the call to reduceRight begins will not be visited by callbackfn. If existing elements of the array are changed by callbackfn, their value as passed to callbackfn will be the value at the time reduceRight visits them; elements that are deleted after the call to reduceRight begins and before being visited are not visited.
When the reduceRight method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - If len is 0 and initialValue is not present, throw a
TypeError exception. - Let k be len - 1.
- Let accumulator be
undefined . - If initialValue is present, then
Set accumulator to initialValue.
- Else,
- Repeat, while k ≥ 0
- Return accumulator.
The reduceRight function is intentionally generic; it does not require that its
22.1.3.23 Array.prototype.reverse ( )
The elements of the array are rearranged so as to reverse their order. The object is returned as the result of the call.
When the reverse method is called, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let middle be
floor (len / 2). - Let lower be 0.
- Repeat, while lower ≠ middle
- Let upper be len - lower - 1.
- Let upperP be !
ToString (upper). - Let lowerP be !
ToString (lower). - Let lowerExists be ?
HasProperty (O, lowerP). - If lowerExists is
true , then- Let lowerValue be ?
Get (O, lowerP).
- Let lowerValue be ?
- Let upperExists be ?
HasProperty (O, upperP). - If upperExists is
true , then- Let upperValue be ?
Get (O, upperP).
- Let upperValue be ?
- If lowerExists is
true and upperExists istrue , then - Else if lowerExists is
false and upperExists istrue , then- Perform ?
Set (O, lowerP, upperValue,true ). - Perform ?
DeletePropertyOrThrow (O, upperP).
- Perform ?
- Else if lowerExists is
true and upperExists isfalse , then- Perform ?
DeletePropertyOrThrow (O, lowerP). - Perform ?
Set (O, upperP, lowerValue,true ).
- Perform ?
- Else,
Assert : lowerExists and upperExists are bothfalse .- No action is required.
Set lower to lower + 1.
- Return O.
The reverse function is intentionally generic; it does not require that its
22.1.3.24 Array.prototype.shift ( )
The first element of the array is removed from the array and returned.
When the shift method is called, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If len is zero, then
- Perform ?
Set (O,"length" , 0,true ). - Return
undefined .
- Perform ?
- Let first be ?
Get (O,"0" ). - Let k be 1.
- Repeat, while k < len
- Let from be !
ToString (k). - Let to be !
ToString (k - 1). - Let fromPresent be ?
HasProperty (O, from). - If fromPresent is
true , then - Else,
Assert : fromPresent isfalse .- Perform ?
DeletePropertyOrThrow (O, to).
Set k to k + 1.
- Let from be !
- Perform ?
DeletePropertyOrThrow (O, !ToString (len - 1)). - Perform ?
Set (O,"length" , len - 1,true ). - Return first.
The shift function is intentionally generic; it does not require that its
22.1.3.25 Array.prototype.slice ( start, end )
The slice method takes two arguments, start and end, and returns an array containing the elements of the array from element start up to, but not including, element end (or through the end of the array if end is
The following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let k be
max ((len + relativeStart), 0); else let k bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - Let count be
max (final - k, 0). - Let A be ?
ArraySpeciesCreate (O, count). - Let n be 0.
- Repeat, while k < final
- Let Pk be !
ToString (k). - Let kPresent be ?
HasProperty (O, Pk). - If kPresent is
true , then- Let kValue be ?
Get (O, Pk). - Perform ?
CreateDataPropertyOrThrow (A, !ToString (n), kValue).
- Let kValue be ?
Set k to k + 1.Set n to n + 1.
- Let Pk be !
- Perform ?
Set (A,"length" , n,true ). - Return A.
The explicit setting of the
The slice function is intentionally generic; it does not require that its
22.1.3.26 Array.prototype.some ( callbackfn [ , thisArg ] )
callbackfn should be a function that accepts three arguments and returns a value that is coercible to the Boolean value some calls callbackfn once for each element present in the array, in ascending order, until it finds one where callbackfn returns some immediately returns some returns
If a thisArg parameter is provided, it will be used as the
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
some does not directly mutate the object on which it is called but the object may be mutated by the calls to callbackfn.
The range of elements processed by some is set before the first call to callbackfn. Elements that are appended to the array after the call to some begins will not be visited by callbackfn. If existing elements of the array are changed, their value as passed to callbackfn will be the value at the time that some visits them; elements that are deleted after the call to some begins and before being visited are not visited. some acts like the "exists" quantifier in mathematics. In particular, for an empty array, it returns
When the some method is called with one or two arguments, the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let k be 0.
- Repeat, while k < len
- Return
false .
The some function is intentionally generic; it does not require that its
22.1.3.27 Array.prototype.sort ( comparefn )
The elements of this array are sorted. The sort must be stable (that is, elements that compare equal must remain in their original order). If comparefn is not
Upon entry, the following steps are performed to initialize evaluation of the sort function:
- If comparefn is not
undefined andIsCallable (comparefn) isfalse , throw aTypeError exception. - Let obj be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (obj).
Within this specification of the sort method, an object, obj, is said to be sparse if the following algorithm returns
The sort order is the ordering, after completion of this function, of the sort function is then determined as follows:
If comparefn is not
Let proto be obj.[[GetPrototypeOf]](). If proto is not
- obj is sparse
- 0 ≤ j < len
-
HasProperty (proto,ToString (j)) istrue .
The sort order is also implementation-defined if obj is sparse and any of the following conditions are true:
-
IsExtensible (obj) isfalse . -
Any
integer index property of obj whose name is a nonnegativeinteger less than len is adata property whose [[Configurable]] attribute isfalse .
The sort order is also implementation-defined if any of the following conditions are true:
-
If obj is an
exotic object (including Proxy exotic objects) whose behaviour for [[Get]], [[Set]], [[Delete]], and [[GetOwnProperty]] is not theordinary object implementation of these internal methods. -
If any index property of obj whose name is a nonnegative
integer less than len is anaccessor property or is adata property whose [[Writable]] attribute isfalse . -
If comparefn is
undefined and the application ofToString to any value passed as an argument toSortCompare modifies obj or any object on obj's prototype chain. -
If comparefn is
undefined and all applications ofToString , to any specific value passed as an argument toSortCompare , do not produce the same result.
The following steps are taken:
- Perform an implementation-dependent sequence of calls to the
Get ,Set ,DeletePropertyOrThrow , andHasOwnProperty abstract operation with obj as the first argument, and toSortCompare (described below), such that:- The property key argument for each call to
Get ,Set ,HasOwnProperty , orDeletePropertyOrThrow is the string representation of a nonnegativeinteger less than len. - The
Throwargument for every call toSet istrue . - The arguments for calls to
SortCompare are values returned by a previous call to theGet abstract operation, unless the properties accessed by those previous calls did not exist according toHasOwnProperty . If both prospective arguments toSortCompare correspond to non-existent properties, use+0 instead of callingSortCompare . If only the first prospective argument is non-existent use +1. If only the second prospective argument is non-existent use -1. - If obj is not sparse then
DeletePropertyOrThrow must not be called. - If an
abrupt completion is returned from any of these operations, it is immediately returned as the value of this function.
- The property key argument for each call to
- Return obj.
Unless the sort order is specified above to be implementation-defined, the returned object must have the following two characteristics:
-
There must be some mathematical permutation π of the nonnegative integers less than len, such that for every nonnegative
integer j less than len, if propertyold[j] existed, thennew[π(j)] is exactly the same value asold[j] . But if propertyold[j] did not exist, thennew[π(j)] does not exist. -
Then for all nonnegative integers j and k, each less than len, if
(seeSortCompare (old[j], old[k]) < 0SortCompare below), thennew[π(j)] < new[π(k)] .
Here the notation
A function comparefn is a consistent comparison function for a set of values S if all of the requirements below are met for all values a, b, and c (possibly the same value) in the set S: The notation
-
Calling comparefn(a, b) always returns the same value v when given a specific pair of values a and b as its two arguments. Furthermore,
Type (v) is Number, and v is notNaN . Note that this implies that exactly one of a <CF b, a =CF b, and a >CF b will be true for a given pair of a and b. - Calling comparefn(a, b) does not modify obj or any object on obj's prototype chain.
- a =CF a (reflexivity)
- If a =CF b, then b =CF a (symmetry)
- If a =CF b and b =CF c, then a =CF c (transitivity of =CF)
- If a <CF b and b <CF c, then a <CF c (transitivity of <CF)
- If a >CF b and b >CF c, then a >CF c (transitivity of >CF)
The above conditions are necessary and sufficient to ensure that comparefn divides the set S into equivalence classes and that these equivalence classes are totally ordered.
The sort function is intentionally generic; it does not require that its
22.1.3.27.1 Runtime Semantics: SortCompare ( x, y )
The SortCompare abstract operation is called with two arguments x and y. It also has access to the comparefn argument passed to the current invocation of the sort method. The following steps are taken:
- If x and y are both
undefined , return+0 . - If x is
undefined , return 1. - If y is
undefined , return -1. - If comparefn is not
undefined , then - Let xString be ?
ToString (x). - Let yString be ?
ToString (y). - Let xSmaller be the result of performing
Abstract Relational Comparison xString < yString. - If xSmaller is
true , return -1. - Let ySmaller be the result of performing
Abstract Relational Comparison yString < xString. - If ySmaller is
true , return 1. - Return
+0 .
Because non-existent property values always compare greater than
Method calls performed by the
22.1.3.28 Array.prototype.splice ( start, deleteCount, ...items )
When the splice method is called with two or more arguments start, deleteCount and zero or more items, the deleteCount elements of the array starting at
The following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let actualStart be
max ((len + relativeStart), 0); else let actualStart bemin (relativeStart, len). - If the number of actual arguments is 0, then
- Let insertCount be 0.
- Let actualDeleteCount be 0.
- Else if the number of actual arguments is 1, then
- Let insertCount be 0.
- Let actualDeleteCount be len - actualStart.
- Else,
- If len + insertCount - actualDeleteCount > 253 - 1, throw a
TypeError exception. - Let A be ?
ArraySpeciesCreate (O, actualDeleteCount). - Let k be 0.
- Repeat, while k < actualDeleteCount
- Let from be !
ToString (actualStart + k). - Let fromPresent be ?
HasProperty (O, from). - If fromPresent is
true , then- Let fromValue be ?
Get (O, from). - Perform ?
CreateDataPropertyOrThrow (A, !ToString (k), fromValue).
- Let fromValue be ?
Set k to k + 1.
- Let from be !
- Perform ?
Set (A,"length" , actualDeleteCount,true ). - Let items be a
List whose elements are, in left to right order, the portion of the actual argument list starting with the third argument. The list is empty if fewer than three arguments were passed. - Let itemCount be the number of elements in items.
- If itemCount < actualDeleteCount, then
Set k to actualStart.- Repeat, while k < (len - actualDeleteCount)
- Let from be !
ToString (k + actualDeleteCount). - Let to be !
ToString (k + itemCount). - Let fromPresent be ?
HasProperty (O, from). - If fromPresent is
true , then - Else,
Assert : fromPresent isfalse .- Perform ?
DeletePropertyOrThrow (O, to).
Set k to k + 1.
- Let from be !
Set k to len.- Repeat, while k > (len - actualDeleteCount + itemCount)
- Perform ?
DeletePropertyOrThrow (O, !ToString (k - 1)). Set k to k - 1.
- Perform ?
- Else if itemCount > actualDeleteCount, then
Set k to (len - actualDeleteCount).- Repeat, while k > actualStart
- Let from be !
ToString (k + actualDeleteCount - 1). - Let to be !
ToString (k + itemCount - 1). - Let fromPresent be ?
HasProperty (O, from). - If fromPresent is
true , then - Else,
Assert : fromPresent isfalse .- Perform ?
DeletePropertyOrThrow (O, to).
Set k to k - 1.
- Let from be !
Set k to actualStart.- Repeat, while items is not empty
- Perform ?
Set (O,"length" , len - actualDeleteCount + itemCount,true ). - Return A.
The explicit setting of the
The splice function is intentionally generic; it does not require that its
22.1.3.29 Array.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement the Array.prototype.toLocaleString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of the toLocaleString method is used.
The first edition of ECMA-402 did not include a replacement specification for the Array.prototype.toLocaleString method.
The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
The following steps are taken:
- Let array be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (array). - Let separator be the String value for the list-separator String appropriate for the host environment's current locale (this is derived in an implementation-defined way).
- Let R be the empty String.
- Let k be 0.
- Repeat, while k < len
- If k > 0, then
Set R to thestring-concatenation of R and separator.
- Let nextElement be ?
Get (array, !ToString (k)). - If nextElement is not
undefined ornull , then- Let S be ?
ToString (?Invoke (nextElement,"toLocaleString" )). Set R to thestring-concatenation of R and S.
- Let S be ?
Set k to k + 1.
- If k > 0, then
- Return R.
The elements of the array are converted to Strings using their toLocaleString methods, and these Strings are then concatenated, separated by occurrences of a separator String that has been derived in an implementation-defined locale-specific way. The result of calling this function is intended to be analogous to the result of toString, except that the result of this function is intended to be locale-specific.
The toLocaleString function is intentionally generic; it does not require that its
22.1.3.30 Array.prototype.toString ( )
When the toString method is called, the following steps are taken:
- Let array be ?
ToObject (this value). - Let func be ?
Get (array,"join" ). - If
IsCallable (func) isfalse , set func to the intrinsic function%Object.prototype.toString% . - Return ?
Call (func, array).
The toString function is intentionally generic; it does not require that its
22.1.3.31 Array.prototype.unshift ( ...items )
The arguments are prepended to the start of the array, such that their order within the array is the same as the order in which they appear in the argument list.
When the unshift method is called with zero or more arguments item1, item2, etc., the following steps are taken:
- Let O be ?
ToObject (this value). - Let len be ?
LengthOfArrayLike (O). - Let argCount be the number of actual arguments.
- If argCount > 0, then
- If len + argCount > 253 - 1, throw a
TypeError exception. - Let k be len.
- Repeat, while k > 0,
- Let from be !
ToString (k - 1). - Let to be !
ToString (k + argCount - 1). - Let fromPresent be ?
HasProperty (O, from). - If fromPresent is
true , then - Else,
Assert : fromPresent isfalse .- Perform ?
DeletePropertyOrThrow (O, to).
Set k to k - 1.
- Let from be !
- Let j be 0.
- Let items be a
List whose elements are, in left to right order, the arguments that were passed to this function invocation. - Repeat, while items is not empty
- If len + argCount > 253 - 1, throw a
- Perform ?
Set (O,"length" , len + argCount,true ). - Return len + argCount.
The unshift method is 1.
The unshift function is intentionally generic; it does not require that its
22.1.3.32 Array.prototype.values ( )
The following steps are taken:
- Let O be ?
ToObject (this value). - Return
CreateArrayIterator (O,value ).
This function is the %ArrayProto_values% intrinsic object.
22.1.3.33 Array.prototype [ @@iterator ] ( )
The initial value of the @@iterator property is the same Array.prototype.values property.
22.1.3.34 Array.prototype [ @@unscopables ]
The initial value of the @@unscopables
- Let unscopableList be
OrdinaryObjectCreate (null ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"copyWithin" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"entries" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"fill" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"find" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"findIndex" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"flat" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"flatMap" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"includes" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"keys" ,true ). - Perform !
CreateDataPropertyOrThrow (unscopableList,"values" ,true ). - Return unscopableList.
This property has the attributes { [[Writable]]:
The own property names of this object are property names that were not included as standard properties of Array.prototype prior to the ECMAScript 2015 specification. These names are ignored for with statement binding purposes in order to preserve the behaviour of existing code that might use one of these names as a binding in an outer scope that is shadowed by a with statement whose binding object is an Array object.
22.1.4 Properties of Array Instances
Array instances are Array exotic objects and have the internal methods specified for such objects. Array instances inherit properties from the Array prototype object.
Array instances have a
22.1.4.1 length
The
The
Reducing the value of the
22.1.5 Array Iterator Objects
An Array Iterator is an object, that represents a specific iteration over some specific Array instance object. There is not a named
22.1.5.1 CreateArrayIterator ( array, kind )
Several methods of Array objects return Iterator objects. The abstract operation CreateArrayIterator with arguments array and kind is used to create such iterator objects. It performs the following steps:
Assert :Type (array) is Object.Assert : kind iskey+value ,key , orvalue .- Let iterator be
OrdinaryObjectCreate (%ArrayIteratorPrototype% , « [[IteratedArrayLike]], [[ArrayLikeNextIndex]], [[ArrayLikeIterationKind]] »). Set iterator.[[IteratedArrayLike]] to array.Set iterator.[[ArrayLikeNextIndex]] to 0.Set iterator.[[ArrayLikeIterationKind]] to kind.- Return iterator.
22.1.5.2 The %ArrayIteratorPrototype% Object
The
- has properties that are inherited by all Array Iterator Objects.
- is an
ordinary object . - has a [[Prototype]] internal slot whose value is
%IteratorPrototype% . - has the following properties:
22.1.5.2.1 %ArrayIteratorPrototype% .next ( )
- Let O be the
this value. - If
Type (O) is not Object, throw aTypeError exception. - If O does not have all of the internal slots of an Array Iterator Instance (
22.1.5.3 ), throw aTypeError exception. - Let a be O.[[IteratedArrayLike]].
- If a is
undefined , returnCreateIterResultObject (undefined ,true ). - Let index be O.[[ArrayLikeNextIndex]].
- Let itemKind be O.[[ArrayLikeIterationKind]].
- If a has a [[TypedArrayName]] internal slot, then
- If
IsDetachedBuffer (a.[[ViewedArrayBuffer]]) istrue , throw aTypeError exception. - Let len be a.[[ArrayLength]].
- If
- Else,
- Let len be ?
LengthOfArrayLike (a).
- Let len be ?
- If index ≥ len, then
Set O.[[IteratedArrayLike]] toundefined .- Return
CreateIterResultObject (undefined ,true ).
Set O.[[ArrayLikeNextIndex]] to index + 1.- If itemKind is
key , returnCreateIterResultObject (index,false ). - Let elementKey be !
ToString (index). - Let elementValue be ?
Get (a, elementKey). - If itemKind is
value , let result be elementValue. - Else,
Assert : itemKind iskey+value .- Let result be !
CreateArrayFromList (« index, elementValue »).
- Return
CreateIterResultObject (result,false ).
22.1.5.2.2 %ArrayIteratorPrototype% [ @@toStringTag ]
The initial value of the @@toStringTag property is the String value
This property has the attributes { [[Writable]]:
22.1.5.3 Properties of Array Iterator Instances
Array Iterator instances are ordinary objects that inherit properties from the
| Internal Slot | Description |
|---|---|
| [[IteratedArrayLike]] |
The |
| [[ArrayLikeNextIndex]] |
The |
| [[ArrayLikeIterationKind]] |
A String value that identifies what is returned for each element of the iteration. The possible values are: |
22.2 TypedArray Objects
TypedArray objects present an array-like view of an underlying binary data buffer (
|
|
Element |
Element Size | Conversion Operation | Description |
|---|---|---|---|---|
|
Int8Array
|
|
1 |
|
8-bit 2's complement signed |
|
Uint8Array
|
|
1 |
|
8-bit unsigned |
|
Uint8ClampedArray
|
|
1 |
|
8-bit unsigned |
|
Int16Array
|
|
2 |
|
16-bit 2's complement signed |
|
Uint16Array
|
|
2 |
|
16-bit unsigned |
|
Int32Array
|
|
4 |
|
32-bit 2's complement signed |
|
Uint32Array
|
|
4 |
|
32-bit unsigned |
|
BigInt64Array
|
|
8 |
|
64-bit two's complement signed |
|
BigUint64Array
|
|
8 |
|
64-bit unsigned |
|
Float32Array
|
|
4 | 32-bit IEEE floating point | |
|
Float64Array
|
|
8 | 64-bit IEEE floating point |
In the definitions below, references to TypedArray should be replaced with the appropriate
22.2.1 The %TypedArray% Intrinsic Object
The
- is a
constructor function object that all of the TypedArrayconstructor objects inherit from. - along with its corresponding prototype object, provides common properties that are inherited by all TypedArray constructors and their instances.
- does not have a global name or appear as a property of the
global object . - acts as the abstract superclass of the various TypedArray constructors.
- will throw an error when invoked, because it is an abstract class
constructor . The TypedArray constructors do not perform asupercall to it.
22.2.1.1 %TypedArray% ( )
The
- Throw a
TypeError exception.
The
22.2.2 Properties of the %TypedArray% Intrinsic Object
The
- has a [[Prototype]] internal slot whose value is
%Function.prototype% . - has a
"name" property whose value is"TypedArray" . - has the following properties:
22.2.2.1 %TypedArray% .from ( source [ , mapfn [ , thisArg ] ] )
When the from method is called with argument source, and optional arguments mapfn and thisArg, the following steps are taken:
- Let C be the
this value. - If
IsConstructor (C) isfalse , throw aTypeError exception. - If mapfn is
undefined , let mapping befalse . - Else,
- If
IsCallable (mapfn) isfalse , throw aTypeError exception. - Let mapping be
true .
- If
- Let usingIterator be ?
GetMethod (source, @@iterator). - If usingIterator is not
undefined , then- Let values be ?
IterableToList (source, usingIterator). - Let len be the number of elements in values.
- Let targetObj be ?
TypedArrayCreate (C, « len »). - Let k be 0.
- Repeat, while k < len
Assert : values is now an emptyList .- Return targetObj.
- Let values be ?
- NOTE: source is not an Iterable so assume it is already an
array-like object . - Let arrayLike be !
ToObject (source). - Let len be ?
LengthOfArrayLike (arrayLike). - Let targetObj be ?
TypedArrayCreate (C, « len »). - Let k be 0.
- Repeat, while k < len
- Return targetObj.
22.2.2.1.1 Runtime Semantics: IterableToList ( items, method )
The abstract operation IterableToList performs the following steps:
- Let iteratorRecord be ?
GetIterator (items,sync , method). - Let values be a new empty
List . - Let next be
true . - Repeat, while next is not
false Set next to ?IteratorStep (iteratorRecord).- If next is not
false , then- Let nextValue be ?
IteratorValue (next). - Append nextValue to the end of the
List values.
- Let nextValue be ?
- Return values.
22.2.2.2 %TypedArray% .of ( ...items )
When the of method is called with any number of arguments, the following steps are taken:
- Let len be the actual number of arguments passed to this function.
- Let items be the
List of arguments passed to this function. - Let C be the
this value. - If
IsConstructor (C) isfalse , throw aTypeError exception. - Let newObj be ?
TypedArrayCreate (C, « len »). - Let k be 0.
- Repeat, while k < len
- Return newObj.
The items argument is assumed to be a well-formed rest argument value.
22.2.2.3 %TypedArray% .prototype
The initial value of .prototype is the
This property has the attributes { [[Writable]]:
22.2.2.4 get %TypedArray% [ @@species ]
[@@species] is an
- Return the
this value.
The value of the
22.2.3 Properties of the %TypedArray.prototype% Object
The
- has a [[Prototype]] internal slot whose value is
%Object.prototype% . - is an
ordinary object . - does not have a [[ViewedArrayBuffer]] or any other of the internal slots that are specific to TypedArray instance objects.
22.2.3.1 get %TypedArray% .prototype.buffer
.prototype.buffer is an
- Let O be the
this value. - Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has a [[ViewedArrayBuffer]] internal slot.- Let buffer be O.[[ViewedArrayBuffer]].
- Return buffer.
22.2.3.2 get %TypedArray% .prototype.byteLength
.prototype.byteLength is an
- Let O be the
this value. - Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has a [[ViewedArrayBuffer]] internal slot.- Let buffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (buffer) istrue , return 0. - Let size be O.[[ByteLength]].
- Return size.
22.2.3.3 get %TypedArray% .prototype.byteOffset
.prototype.byteOffset is an
- Let O be the
this value. - Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has a [[ViewedArrayBuffer]] internal slot.- Let buffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (buffer) istrue , return 0. - Let offset be O.[[ByteOffset]].
- Return offset.
22.2.3.4 %TypedArray% .prototype.constructor
The initial value of .prototype.constructor is the
22.2.3.5 %TypedArray% .prototype.copyWithin ( target, start [ , end ] )
The interpretation and use of the arguments of .prototype.copyWithin are the same as for Array.prototype.copyWithin as defined in
The following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Let len be O.[[ArrayLength]].
- Let relativeTarget be ?
ToInteger (target). - If relativeTarget < 0, let to be
max ((len + relativeTarget), 0); else let to bemin (relativeTarget, len). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let from be
max ((len + relativeStart), 0); else let from bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - Let count be
min (final - from, len - to). - If count > 0, then
- NOTE: The copying must be performed in a manner that preserves the bit-level encoding of the source data.
- Let buffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (buffer) istrue , throw aTypeError exception. - Let typedArrayName be the String value of O.[[TypedArrayName]].
- Let elementSize be the Element Size value specified in
Table 61 for typedArrayName. - Let byteOffset be O.[[ByteOffset]].
- Let toByteIndex be to × elementSize + byteOffset.
- Let fromByteIndex be from × elementSize + byteOffset.
- Let countBytes be count × elementSize.
- If fromByteIndex < toByteIndex and toByteIndex < fromByteIndex + countBytes, then
- Else,
- Let direction be 1.
- Repeat, while countBytes > 0
- Let value be
GetValueFromBuffer (buffer, fromByteIndex,Uint8 ,true ,Unordered ). - Perform
SetValueInBuffer (buffer, toByteIndex,Uint8 , value,true ,Unordered ). Set fromByteIndex to fromByteIndex + direction.Set toByteIndex to toByteIndex + direction.Set countBytes to countBytes - 1.
- Let value be
- Return O.
22.2.3.5.1 Runtime Semantics: ValidateTypedArray ( O )
When called with argument O, the following steps are taken:
- Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has a [[ViewedArrayBuffer]] internal slot.- Let buffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (buffer) istrue , throw aTypeError exception. - Return buffer.
22.2.3.6 %TypedArray% .prototype.entries ( )
The following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Return
CreateArrayIterator (O,key+value ).
22.2.3.7 %TypedArray% .prototype.every ( callbackfn [ , thisArg ] )
.prototype.every is a distinct function that implements the same algorithm as Array.prototype.every as defined in
This function is not generic.
22.2.3.8 %TypedArray% .prototype.fill ( value [ , start [ , end ] ] )
The interpretation and use of the arguments of .prototype.fill are the same as for Array.prototype.fill as defined in
The following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Let len be O.[[ArrayLength]].
- If O.[[ContentType]] is
BigInt , set value to ?ToBigInt (value). - Otherwise, set value to ?
ToNumber (value). - Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let k be
max ((len + relativeStart), 0); else let k bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - If
IsDetachedBuffer (O.[[ViewedArrayBuffer]]) istrue , throw aTypeError exception. - Repeat, while k < final
- Return O.
22.2.3.9 %TypedArray% .prototype.filter ( callbackfn [ , thisArg ] )
The interpretation and use of the arguments of .prototype.filter are the same as for Array.prototype.filter as defined in
When the filter method is called with one or two arguments, the following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Let len be O.[[ArrayLength]].
- If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let kept be a new empty
List . - Let k be 0.
- Let captured be 0.
- Repeat, while k < len
- Let A be ?
TypedArraySpeciesCreate (O, « captured »). - Let n be 0.
- For each element e of kept, do
- Return A.
This function is not generic. The
22.2.3.10 %TypedArray% .prototype.find ( predicate [ , thisArg ] )
.prototype.find is a distinct function that implements the same algorithm as Array.prototype.find as defined in
This function is not generic.
22.2.3.11 %TypedArray% .prototype.findIndex ( predicate [ , thisArg ] )
.prototype.findIndex is a distinct function that implements the same algorithm as Array.prototype.findIndex as defined in
This function is not generic.
22.2.3.12 %TypedArray% .prototype.forEach ( callbackfn [ , thisArg ] )
.prototype.forEach is a distinct function that implements the same algorithm as Array.prototype.forEach as defined in
This function is not generic.
22.2.3.13 %TypedArray% .prototype.includes ( searchElement [ , fromIndex ] )
.prototype.includes is a distinct function that implements the same algorithm as Array.prototype.includes as defined in
This function is not generic.
22.2.3.14 %TypedArray% .prototype.indexOf ( searchElement [ , fromIndex ] )
.prototype.indexOf is a distinct function that implements the same algorithm as Array.prototype.indexOf as defined in
This function is not generic.
22.2.3.15 %TypedArray% .prototype.join ( separator )
.prototype.join is a distinct function that implements the same algorithm as Array.prototype.join as defined in
This function is not generic.
22.2.3.16 %TypedArray% .prototype.keys ( )
The following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Return
CreateArrayIterator (O,key ).
22.2.3.17 %TypedArray% .prototype.lastIndexOf ( searchElement [ , fromIndex ] )
.prototype.lastIndexOf is a distinct function that implements the same algorithm as Array.prototype.lastIndexOf as defined in
This function is not generic.
22.2.3.18 get %TypedArray% .prototype.length
.prototype.length is an
- Let O be the
this value. - Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has [[ViewedArrayBuffer]] and [[ArrayLength]] internal slots.- Let buffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (buffer) istrue , return 0. - Let length be O.[[ArrayLength]].
- Return length.
This function is not generic. The
22.2.3.19 %TypedArray% .prototype.map ( callbackfn [ , thisArg ] )
The interpretation and use of the arguments of .prototype.map are the same as for Array.prototype.map as defined in
When the map method is called with one or two arguments, the following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Let len be O.[[ArrayLength]].
- If
IsCallable (callbackfn) isfalse , throw aTypeError exception. - Let A be ?
TypedArraySpeciesCreate (O, « len »). - Let k be 0.
- Repeat, while k < len
- Return A.
This function is not generic. The
22.2.3.20 %TypedArray% .prototype.reduce ( callbackfn [ , initialValue ] )
.prototype.reduce is a distinct function that implements the same algorithm as Array.prototype.reduce as defined in
This function is not generic.
22.2.3.21 %TypedArray% .prototype.reduceRight ( callbackfn [ , initialValue ] )
.prototype.reduceRight is a distinct function that implements the same algorithm as Array.prototype.reduceRight as defined in
This function is not generic.
22.2.3.22 %TypedArray% .prototype.reverse ( )
.prototype.reverse is a distinct function that implements the same algorithm as Array.prototype.reverse as defined in
This function is not generic.
22.2.3.23 %TypedArray% .prototype.set ( overloaded [ , offset ] )
.prototype.set is a single function whose behaviour is overloaded based upon the
This function is not generic. The
22.2.3.23.1 %TypedArray% .prototype.set ( array [ , offset ] )
Sets multiple values in this TypedArray, reading the values from the object array. The optional offset value indicates the first element index in this TypedArray where values are written. If omitted, it is assumed to be 0.
Assert : array is anyECMAScript language value other than an Object with a [[TypedArrayName]] internal slot. If it is such an Object, the definition in22.2.3.23.2 applies.- Let target be the
this value. - Perform ?
RequireInternalSlot (target, [[TypedArrayName]]). Assert : target has a [[ViewedArrayBuffer]] internal slot.- Let targetOffset be ?
ToInteger (offset). - If targetOffset < 0, throw a
RangeError exception. - Let targetBuffer be target.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (targetBuffer) istrue , throw aTypeError exception. - Let targetLength be target.[[ArrayLength]].
- Let targetName be the String value of target.[[TypedArrayName]].
- Let targetElementSize be the Element Size value specified in
Table 61 for targetName. - Let targetType be the Element
Type value inTable 61 for targetName. - Let targetByteOffset be target.[[ByteOffset]].
- Let src be ?
ToObject (array). - Let srcLength be ?
LengthOfArrayLike (src). - If srcLength + targetOffset > targetLength, throw a
RangeError exception. - Let targetByteIndex be targetOffset × targetElementSize + targetByteOffset.
- Let k be 0.
- Let limit be targetByteIndex + targetElementSize × srcLength.
- Repeat, while targetByteIndex < limit
- Let Pk be !
ToString (k). - Let value be ?
Get (src, Pk). - If target.[[ContentType]] is
BigInt , set value to ?ToBigInt (value). - Otherwise, set value to ?
ToNumber (value). - If
IsDetachedBuffer (targetBuffer) istrue , throw aTypeError exception. - Perform
SetValueInBuffer (targetBuffer, targetByteIndex, targetType, value,true ,Unordered ). Set k to k + 1.Set targetByteIndex to targetByteIndex + targetElementSize.
- Let Pk be !
- Return
undefined .
22.2.3.23.2 %TypedArray% .prototype.set ( typedArray [ , offset ] )
Sets multiple values in this TypedArray, reading the values from the typedArray argument object. The optional offset value indicates the first element index in this TypedArray where values are written. If omitted, it is assumed to be 0.
Assert : typedArray has a [[TypedArrayName]] internal slot. If it does not, the definition in22.2.3.23.1 applies.- Let target be the
this value. - Perform ?
RequireInternalSlot (target, [[TypedArrayName]]). Assert : target has a [[ViewedArrayBuffer]] internal slot.- Let targetOffset be ?
ToInteger (offset). - If targetOffset < 0, throw a
RangeError exception. - Let targetBuffer be target.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (targetBuffer) istrue , throw aTypeError exception. - Let targetLength be target.[[ArrayLength]].
- Let srcBuffer be typedArray.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (srcBuffer) istrue , throw aTypeError exception. - Let targetName be the String value of target.[[TypedArrayName]].
- Let targetType be the Element
Type value inTable 61 for targetName. - Let targetElementSize be the Element Size value specified in
Table 61 for targetName. - Let targetByteOffset be target.[[ByteOffset]].
- Let srcName be the String value of typedArray.[[TypedArrayName]].
- Let srcType be the Element
Type value inTable 61 for srcName. - Let srcElementSize be the Element Size value specified in
Table 61 for srcName. - Let srcLength be typedArray.[[ArrayLength]].
- Let srcByteOffset be typedArray.[[ByteOffset]].
- If srcLength + targetOffset > targetLength, throw a
RangeError exception. - If target.[[ContentType]] is not equal to typedArray.[[ContentType]], throw a
TypeError exception. - If both
IsSharedArrayBuffer (srcBuffer) andIsSharedArrayBuffer (targetBuffer) aretrue , then- If srcBuffer.[[ArrayBufferData]] and targetBuffer.[[ArrayBufferData]] are the same
Shared Data Block values, let same betrue ; else let same befalse .
- If srcBuffer.[[ArrayBufferData]] and targetBuffer.[[ArrayBufferData]] are the same
- Else, let same be
SameValue (srcBuffer, targetBuffer). - If same is
true , then- Let srcByteLength be typedArray.[[ByteLength]].
Set srcBuffer to ?CloneArrayBuffer (srcBuffer, srcByteOffset, srcByteLength,%ArrayBuffer% ).- NOTE:
%ArrayBuffer% is used to clone srcBuffer because is it known to not have any observable side-effects. - Let srcByteIndex be 0.
- Else, let srcByteIndex be srcByteOffset.
- Let targetByteIndex be targetOffset × targetElementSize + targetByteOffset.
- Let limit be targetByteIndex + targetElementSize × srcLength.
- If srcType is the same as targetType, then
- NOTE: If srcType and targetType are the same, the transfer must be performed in a manner that preserves the bit-level encoding of the source data.
- Repeat, while targetByteIndex < limit
- Let value be
GetValueFromBuffer (srcBuffer, srcByteIndex,Uint8 ,true ,Unordered ). - Perform
SetValueInBuffer (targetBuffer, targetByteIndex,Uint8 , value,true ,Unordered ). Set srcByteIndex to srcByteIndex + 1.Set targetByteIndex to targetByteIndex + 1.
- Let value be
- Else,
- Repeat, while targetByteIndex < limit
- Let value be
GetValueFromBuffer (srcBuffer, srcByteIndex, srcType,true ,Unordered ). - Perform
SetValueInBuffer (targetBuffer, targetByteIndex, targetType, value,true ,Unordered ). Set srcByteIndex to srcByteIndex + srcElementSize.Set targetByteIndex to targetByteIndex + targetElementSize.
- Let value be
- Repeat, while targetByteIndex < limit
- Return
undefined .
22.2.3.24 %TypedArray% .prototype.slice ( start, end )
The interpretation and use of the arguments of .prototype.slice are the same as for Array.prototype.slice as defined in
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Let len be O.[[ArrayLength]].
- Let relativeStart be ?
ToInteger (start). - If relativeStart < 0, let k be
max ((len + relativeStart), 0); else let k bemin (relativeStart, len). - If end is
undefined , let relativeEnd be len; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let final be
max ((len + relativeEnd), 0); else let final bemin (relativeEnd, len). - Let count be
max (final - k, 0). - Let A be ?
TypedArraySpeciesCreate (O, « count »). - Let srcName be the String value of O.[[TypedArrayName]].
- Let srcType be the Element
Type value inTable 61 for srcName. - Let targetName be the String value of A.[[TypedArrayName]].
- Let targetType be the Element
Type value inTable 61 for targetName. - If srcType is different from targetType, then
- Else if count > 0, then
- Let srcBuffer be O.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (srcBuffer) istrue , throw aTypeError exception. - Let targetBuffer be A.[[ViewedArrayBuffer]].
- Let elementSize be the Element Size value specified in
Table 61 for ElementType srcType. - NOTE: If srcType and targetType are the same, the transfer must be performed in a manner that preserves the bit-level encoding of the source data.
- Let srcByteOffet be O.[[ByteOffset]].
- Let targetByteIndex be A.[[ByteOffset]].
- Let srcByteIndex be (k × elementSize) + srcByteOffet.
- Let limit be targetByteIndex + count × elementSize.
- Repeat, while targetByteIndex < limit
- Let value be
GetValueFromBuffer (srcBuffer, srcByteIndex,Uint8 ,true ,Unordered ). - Perform
SetValueInBuffer (targetBuffer, targetByteIndex,Uint8 , value,true ,Unordered ). Set srcByteIndex to srcByteIndex + 1.Set targetByteIndex to targetByteIndex + 1.
- Let value be
- Return A.
This function is not generic. The
22.2.3.25 %TypedArray% .prototype.some ( callbackfn [ , thisArg ] )
.prototype.some is a distinct function that implements the same algorithm as Array.prototype.some as defined in
This function is not generic.
22.2.3.26 %TypedArray% .prototype.sort ( comparefn )
.prototype.sort is a distinct function that, except as described below, implements the same requirements as those of Array.prototype.sort as defined in .prototype.sort specification may be optimized with the knowledge that the
This function is not generic. The
Upon entry, the following steps are performed to initialize evaluation of the sort function. These steps are used instead of the entry steps in
- If comparefn is not
undefined andIsCallable (comparefn) isfalse , throw aTypeError exception. - Let obj be the
this value. - Let buffer be ?
ValidateTypedArray (obj). - Let len be obj.[[ArrayLength]].
The implementation-defined sort order condition for exotic objects is not applied by .prototype.sort.
The following version of .prototype.sort. It performs a numeric comparison rather than the string comparison used in sort method.
When the TypedArray
Assert : BothType (x) andType (y) are Number or both are BigInt.- If comparefn is not
undefined , then- Let v be ?
ToNumber (?Call (comparefn,undefined , « x, y »)). - If
IsDetachedBuffer (buffer) istrue , throw aTypeError exception. - If v is
NaN , return+0 . - Return v.
- Let v be ?
- If x and y are both
NaN , return+0 . - If x is
NaN , return 1. - If y is
NaN , return -1. - If x < y, return -1.
- If x > y, return 1.
- If x is
-0 and y is+0 , return -1. - If x is
+0 and y is-0 , return 1. - Return
+0 .
Because
22.2.3.27 %TypedArray% .prototype.subarray ( begin, end )
Returns a new TypedArray object whose element
- Let O be the
this value. - Perform ?
RequireInternalSlot (O, [[TypedArrayName]]). Assert : O has a [[ViewedArrayBuffer]] internal slot.- Let buffer be O.[[ViewedArrayBuffer]].
- Let srcLength be O.[[ArrayLength]].
- Let relativeBegin be ?
ToInteger (begin). - If relativeBegin < 0, let beginIndex be
max ((srcLength + relativeBegin), 0); else let beginIndex bemin (relativeBegin, srcLength). - If end is
undefined , let relativeEnd be srcLength; else let relativeEnd be ?ToInteger (end). - If relativeEnd < 0, let endIndex be
max ((srcLength + relativeEnd), 0); else let endIndex bemin (relativeEnd, srcLength). - Let newLength be
max (endIndex - beginIndex, 0). - Let constructorName be the String value of O.[[TypedArrayName]].
- Let elementSize be the Element Size value specified in
Table 61 for constructorName. - Let srcByteOffset be O.[[ByteOffset]].
- Let beginByteOffset be srcByteOffset + beginIndex × elementSize.
- Let argumentsList be « buffer, beginByteOffset, newLength ».
- Return ?
TypedArraySpeciesCreate (O, argumentsList).
This function is not generic. The
22.2.3.28 %TypedArray% .prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )
.prototype.toLocaleString is a distinct function that implements the same algorithm as Array.prototype.toLocaleString as defined in
This function is not generic.
If the ECMAScript implementation includes the ECMA-402 Internationalization API this function is based upon the algorithm for Array.prototype.toLocaleString that is in the ECMA-402 specification.
22.2.3.29 %TypedArray% .prototype.toString ( )
The initial value of the .prototype.toString Array.prototype.toString method defined in
22.2.3.30 %TypedArray% .prototype.values ( )
The following steps are taken:
- Let O be the
this value. - Perform ?
ValidateTypedArray (O). - Return
CreateArrayIterator (O,value ).
22.2.3.31 %TypedArray% .prototype [ @@iterator ] ( )
The initial value of the @@iterator property is the same .prototype.values property.
22.2.3.32 get %TypedArray% .prototype [ @@toStringTag ]
.prototype[@@toStringTag] is an
This property has the attributes { [[Enumerable]]:
The initial value of the
22.2.4 The TypedArray Constructors
Each TypedArray
- is an intrinsic object that has the structure described below, differing only in the name used as the
constructor name instead of TypedArray, inTable 61 . - is a single function whose behaviour is overloaded based upon the number and types of its arguments. The actual behaviour of a call of TypedArray depends upon the number and kind of arguments that are passed to it.
- is not intended to be called as a function and will throw an exception when called in that manner.
- is designed to be subclassable. It may be used as the value of an
extendsclause of a class definition. Subclass constructors that intend to inherit the specified TypedArray behaviour must include asupercall to the TypedArrayconstructor to create and initialize the subclass instance with the internal state necessary to support the%TypedArray% .prototypebuilt-in methods. - has a
"length" property whose value is 3.
22.2.4.1 TypedArray ( )
This description applies only if the TypedArray function is called with no arguments.
- If NewTarget is
undefined , throw aTypeError exception. - Let constructorName be the String value of the
Constructor Name value specified inTable 61 for this TypedArrayconstructor . - Return ?
AllocateTypedArray (constructorName, NewTarget,"%TypedArray.prototype%", 0).
22.2.4.2 TypedArray ( length )
This description applies only if the TypedArray function is called with at least one argument and the
TypedArray called with argument length performs the following steps:
Assert :Type (length) is not Object.- If NewTarget is
undefined , throw aTypeError exception. - Let elementLength be ?
ToIndex (length). - Let constructorName be the String value of the
Constructor Name value specified inTable 61 for this TypedArrayconstructor . - Return ?
AllocateTypedArray (constructorName, NewTarget,"%TypedArray.prototype%", elementLength).
22.2.4.2.1 Runtime Semantics: AllocateTypedArray ( constructorName, newTarget, defaultProto [ , length ] )
The abstract operation AllocateTypedArray with arguments constructorName, newTarget, defaultProto and optional argument length is used to validate and create an instance of a TypedArray
- Let proto be ?
GetPrototypeFromConstructor (newTarget, defaultProto). - Let obj be !
IntegerIndexedObjectCreate (proto). Assert : obj.[[ViewedArrayBuffer]] isundefined .Set obj.[[TypedArrayName]] to constructorName.- If constructorName is
"BigInt64Array" or"BigUint64Array" , set obj.[[ContentType]] toBigInt . - Otherwise, set obj.[[ContentType]] to
Number . - If length is not present, then
- Else,
- Perform ?
AllocateTypedArrayBuffer (obj, length).
- Perform ?
- Return obj.
22.2.4.2.2 Runtime Semantics: AllocateTypedArrayBuffer ( O, length )
The abstract operation AllocateTypedArrayBuffer with arguments O and length allocates and associates an ArrayBuffer with the TypedArray instance O. It performs the following steps:
Assert : O is an Object that has a [[ViewedArrayBuffer]] internal slot.Assert : O.[[ViewedArrayBuffer]] isundefined .Assert : !IsNonNegativeInteger (length) istrue .- Let constructorName be the String value of O.[[TypedArrayName]].
- Let elementSize be the Element Size value specified in
Table 61 for constructorName. - Let byteLength be elementSize × length.
- Let data be ?
AllocateArrayBuffer (%ArrayBuffer% , byteLength). Set O.[[ViewedArrayBuffer]] to data.Set O.[[ByteLength]] to byteLength.Set O.[[ByteOffset]] to 0.Set O.[[ArrayLength]] to length.- Return O.
22.2.4.3 TypedArray ( typedArray )
This description applies only if the TypedArray function is called with at least one argument and the
TypedArray called with argument typedArray performs the following steps:
Assert :Type (typedArray) is Object and typedArray has a [[TypedArrayName]] internal slot.- If NewTarget is
undefined , throw aTypeError exception. - Let constructorName be the String value of the
Constructor Name value specified inTable 61 for this TypedArrayconstructor . - Let O be ?
AllocateTypedArray (constructorName, NewTarget,"%TypedArray.prototype%"). - Let srcArray be typedArray.
- Let srcData be srcArray.[[ViewedArrayBuffer]].
- If
IsDetachedBuffer (srcData) istrue , throw aTypeError exception. - Let elementType be the Element
Type value inTable 61 for constructorName. - Let elementLength be srcArray.[[ArrayLength]].
- Let srcName be the String value of srcArray.[[TypedArrayName]].
- Let srcType be the Element
Type value inTable 61 for srcName. - Let srcElementSize be the Element Size value specified in
Table 61 for srcName. - Let srcByteOffset be srcArray.[[ByteOffset]].
- Let elementSize be the Element Size value specified in
Table 61 for constructorName. - Let byteLength be elementSize × elementLength.
- If
IsSharedArrayBuffer (srcData) isfalse , then- Let bufferConstructor be ?
SpeciesConstructor (srcData,%ArrayBuffer% ).
- Let bufferConstructor be ?
- Else,
- Let bufferConstructor be
%ArrayBuffer% .
- Let bufferConstructor be
- If elementType is the same as srcType, then
- Let data be ?
CloneArrayBuffer (srcData, srcByteOffset, byteLength, bufferConstructor).
- Let data be ?
- Else,
- Let data be ?
AllocateArrayBuffer (bufferConstructor, byteLength). - If
IsDetachedBuffer (srcData) istrue , throw aTypeError exception. - If srcArray.[[ContentType]] is not equal to O.[[ContentType]], throw a
TypeError exception. - Let srcByteIndex be srcByteOffset.
- Let targetByteIndex be 0.
- Let count be elementLength.
- Repeat, while count > 0
- Let value be
GetValueFromBuffer (srcData, srcByteIndex, srcType,true ,Unordered ). - Perform
SetValueInBuffer (data, targetByteIndex, elementType, value,true ,Unordered ). Set srcByteIndex to srcByteIndex + srcElementSize.Set targetByteIndex to targetByteIndex + elementSize.Set count to count - 1.
- Let value be
- Let data be ?
Set O.[[ViewedArrayBuffer]] to data.Set O.[[ByteLength]] to byteLength.Set O.[[ByteOffset]] to 0.Set O.[[ArrayLength]] to elementLength.- Return O.
22.2.4.4 TypedArray ( object )
This description applies only if the TypedArray function is called with at least one argument and the
TypedArray called with argument object performs the following steps:
Assert :Type (object) is Object and object does not have either a [[TypedArrayName]] or an [[ArrayBufferData]] internal slot.- If NewTarget is
undefined , throw aTypeError exception. - Let constructorName be the String value of the
Constructor Name value specified inTable 61 for this TypedArrayconstructor . - Let O be ?
AllocateTypedArray (constructorName, NewTarget,"%TypedArray.prototype%"). - Let usingIterator be ?
GetMethod (object, @@iterator). - If usingIterator is not
undefined , then- Let values be ?
IterableToList (object, usingIterator). - Let len be the number of elements in values.
- Perform ?
AllocateTypedArrayBuffer (O, len). - Let k be 0.
- Repeat, while k < len
Assert : values is now an emptyList .- Return O.
- Let values be ?
- NOTE: object is not an Iterable so assume it is already an
array-like object . - Let arrayLike be object.
- Let len be ?
LengthOfArrayLike (arrayLike). - Perform ?
AllocateTypedArrayBuffer (O, len). - Let k be 0.
- Repeat, while k < len
- Return O.
22.2.4.5 TypedArray ( buffer [ , byteOffset [ , length ] ] )
This description applies only if the TypedArray function is called with at least one argument and the
TypedArray called with at least one argument buffer performs the following steps:
Assert :Type (buffer) is Object and buffer has an [[ArrayBufferData]] internal slot.- If NewTarget is
undefined , throw aTypeError exception. - Let constructorName be the String value of the
Constructor Name value specified inTable 61 for this TypedArrayconstructor . - Let O be ?
AllocateTypedArray (constructorName, NewTarget,"%TypedArray.prototype%"). - Let elementSize be the Element Size value specified in
Table 61 for constructorName. - Let offset be ?
ToIndex (byteOffset). - If offset
modulo elementSize ≠ 0, throw aRangeError exception. - If length is not
undefined , then- Let newLength be ?
ToIndex (length).
- Let newLength be ?
- If
IsDetachedBuffer (buffer) istrue , throw aTypeError exception. - Let bufferByteLength be buffer.[[ArrayBufferByteLength]].
- If length is
undefined , then- If bufferByteLength
modulo elementSize ≠ 0, throw aRangeError exception. - Let newByteLength be bufferByteLength - offset.
- If newByteLength < 0, throw a
RangeError exception.
- If bufferByteLength
- Else,
- Let newByteLength be newLength × elementSize.
- If offset + newByteLength > bufferByteLength, throw a
RangeError exception.
Set O.[[ViewedArrayBuffer]] to buffer.Set O.[[ByteLength]] to newByteLength.Set O.[[ByteOffset]] to offset.Set O.[[ArrayLength]] to newByteLength / elementSize.- Return O.
22.2.4.6 TypedArrayCreate ( constructor, argumentList )
The abstract operation TypedArrayCreate with arguments constructor and argumentList is used to specify the creation of a new TypedArray object using a
- Let newTypedArray be ?
Construct (constructor, argumentList). - Perform ?
ValidateTypedArray (newTypedArray). - If argumentList is a
List of a single Number, then- If newTypedArray.[[ArrayLength]] < argumentList[0], throw a
TypeError exception.
- If newTypedArray.[[ArrayLength]] < argumentList[0], throw a
- Return newTypedArray.
22.2.4.7 TypedArraySpeciesCreate ( exemplar, argumentList )
The abstract operation TypedArraySpeciesCreate with arguments exemplar and argumentList is used to specify the creation of a new TypedArray object using a
Assert : exemplar is an Object that has [[TypedArrayName]] and [[ContentType]] internal slots.- Let defaultConstructor be the intrinsic object listed in column one of
Table 61 for exemplar.[[TypedArrayName]]. - Let constructor be ?
SpeciesConstructor (exemplar, defaultConstructor). - Let result be ?
TypedArrayCreate (constructor, argumentList). Assert : result has [[TypedArrayName]] and [[ContentType]] internal slots.- If result.[[ContentType]] is not equal to exemplar.[[ContentType]], throw a
TypeError exception. - Return result.
22.2.5 Properties of the TypedArray Constructors
Each TypedArray
- has a [[Prototype]] internal slot whose value is
%TypedArray% . - has a
"name" property whose value is the String value of theconstructor name specified for it inTable 61 . - has the following properties:
22.2.5.1 TypedArray.BYTES_PER_ELEMENT
The value of TypedArray.BYTES_PER_ELEMENT is the Element Size value specified in
This property has the attributes { [[Writable]]:
22.2.5.2 TypedArray.prototype
The initial value of TypedArray.prototype is the corresponding TypedArray prototype intrinsic object (
This property has the attributes { [[Writable]]:
22.2.6 Properties of the TypedArray Prototype Objects
Each TypedArray prototype object:
- has a [[Prototype]] internal slot whose value is
%TypedArray.prototype% . - is an
ordinary object . - does not have a [[ViewedArrayBuffer]] or any other of the internal slots that are specific to TypedArray instance objects.
22.2.6.1 TypedArray.prototype.BYTES_PER_ELEMENT
The value of TypedArray.prototype.BYTES_PER_ELEMENT is the Element Size value specified in
This property has the attributes { [[Writable]]:
22.2.6.2 TypedArray.prototype.constructor
The initial value of a TypedArray.prototype.constructor is the corresponding
22.2.7 Properties of TypedArray Instances
TypedArray instances are