The sort()
method of TypedArray instances sorts the elements of a typed array in place and returns the reference to the same typed array, now sorted. This method has the same algorithm as Array.prototype.sort, except that it sorts the values numerically instead of as strings by default.
Syntax
sort()
sort(compareFn)
Parameters
compareFn
: A function that defines the sort order. The return value should be a number whose sign indicates the relative order of the two elements: negative if
a
is less thanb
, positive ifa
is greater thanb
, and zero if they are equal.NaN
is treated as0
. The function is called with the following arguments:a
- : The first element for comparison. Will never be
undefined
.
- : The first element for comparison. Will never be
b
- : The second element for comparison. Will never be
undefined
.
- : The second element for comparison. Will never be
If omitted, the typed array elements are sorted according to numeric value.
Return value
The reference to the original typed array, now sorted. Note that the typed array is sorted in place, and no copy is made.
Description
See Array.prototype.sort for more details. This method is not generic and can only be called on typed array instances.
Examples
Using sort()
For more examples, see also the Array.prototype.sort method.
let numbers = new Uint8Array([40, 1, 5, 200]);
numbers.sort();
// Uint8Array [ 1, 5, 40, 200 ]
// Unlike plain Arrays, a compare function is not required
// to sort the numbers numerically.
// Regular Arrays require a compare function to sort numerically:
numbers = [40, 1, 5, 200];
numbers.sort();
// [1, 200, 40, 5]
numbers.sort((a, b) => a - b); // compare numbers
// [ 1, 5, 40, 200 ]