Uint8ClampedArray : ArrayBufferView

constructor iterable

Uint8ClampedArray is similar to an Array where each item is a 8 bit (1 byte) unsigned integer. Values stored in this array are clamped to the range 0-255. Uint8ClampedArrays cannot change size after creation.

Spec

Constructors

new Uint8ClampedArray(length : Number) : Uint8ClampedArray

Creates a new Uint8ClampedArray of the specified length where each item starts out as 0

Example:

var x = new Uint8ClampedArray(3);
x[0] = -17;
x[1] = 93;
x[2] = 350;
console.log(x[0]);
console.log(x[1]);
console.log(x[2]);
console.log(x.length);

Run

Results:

new Uint8ClampedArray(array : Array) : Uint8ClampedArray

Creates a new Uint8ClampedArray and copies the items of array into this. The copied items are converted to 8 bit integers before being stored in this.

Example:

var x = new Uint8ClampedArray([17, -45.3]);
console.log(x[0]);
console.log(x[1]);
console.log(x.length);

Run

Results:

new Uint8ClampedArray(array : Uint8ClampedArray) : Uint8ClampedArray

Creates a new Uint8ClampedArray and copies the items of array into this. array can be any of the typed array types and the copied items will be converted to 8 bit integers before being stored in this.

Example:

var x = new Uint8ClampedArray([17, -45.3]);
var y = new Uint8ClampedArray(x);
console.log(x[0]);
console.log(x[1]);
console.log(x.length);
x[0] = -2;
console.log(y[0]); // y is not modified

Run

Results:

new Uint8ClampedArray(buffer : ArrayBuffer, [byteOffset = 0 : Number, [length : Number]]) : Uint8ClampedArray

Creates a view on top of the specified buffer starting at byteOffset of length items. Changes to the items in this actual affect the underlying buffer, and vice versa. If length is not specified, this.length will be buffer.length - byteOffset.

Example:

var buffer = new ArrayBuffer(12);
var x = new Uint8ClampedArray(buffer, 0, 2);
// Make another view of last 4 bytes of the buffer
var y = new Uint8ClampedArray(buffer, 4, 1);
x[1] = 7;
console.log(y[0]); // y is a live view on the buffer

Run

Results:

Instance Indexers

this[index : Number] : Number

Gets and sets the element in this at index. index should be between 0 and this.length - 1. Setting an element to a value less than 0 will store 0 and greater than 255 will store 255 in the array.

Example:

var x = new Uint8ClampedArray(3);
x[0] = 17;
x[1] = -1;
x[2] = 256;
console.log(x[0]);
console.log(x[1]);
console.log(x[2]);

var y = new Uint8Array(2);
y[0] = -1;
y[1] = 256;
console.log(y[0]);
console.log(y[1]);

Run

Results:

Instance Properties

buffer : ArrayBuffer readonly

Returns the underlying buffer for this Uint8ClampedArray.

Example:

var buffer = new ArrayBuffer(12);
var x = new Uint8ClampedArray(buffer, 0, 2);
var y = new Uint8ClampedArray(x.buffer, 4, 2);
console.log(x.buffer === y.buffer);

Run

Results:

byteLength : Number readonly

The length of this in bytes.

Example:

var buffer = new ArrayBuffer(12);
var x = new Uint8ClampedArray(buffer, 4, 2);
console.log(x.byteLength); 
console.log(x.length * Uint8ClampedArray.BYTES_PER_ELEMENT);

Run

Results:

byteOffset : Number readonly

The offset into this.buffer where the 0th item is stored.

Example:

var buffer = new ArrayBuffer(12);
var x = new Uint8ClampedArray(buffer, 4, 2);
console.log(x.byteOffset);

Run

Results:

length : Number readonly

The number of elements in this. It is 1 greater than the index of the last item.

Example:

var x = new Uint8ClampedArray(10);
console.log(x.length);

Run

Results:

Instance Methods

copyWithin(target : Number, start : Number, [end : Number]) : undefined

Copies this[start], this[start + 1], ... this[end - 1] to this[target], this[target + 1], ... If end is not specified, this.length is used.

Example:

var x = new Uint8ClampedArray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
x.copyWithin(0, 5);
console.log(x);

Run

Results:

Spec

entries() : Iterator<Array<Number>>

Returns an iterator of the index and items in this where the values of the iterator are of the form [index : Number, item : Number]. See also values() and keys().

Example:

var x = new Uint8ClampedArray([8, 9]);

// Use for (... of ...) to loop over the iterator
for (var entry of x.entries()) {
  console.dir(entry);
}

// Or access the iterator manually
var entries = x.entries();

console.dir(entries.next());
console.dir(entries.next());
console.dir(entries.next());

Run

Results:

Spec

every(callback : Function, [thisArg : Object]) : Boolean

callback(item : Number, index : Number, array : Uint8ClampedArray) : Boolean

Returns true if callback returns true for every item in this. Otherwise returns false. The Uint8ClampedArray passed to callback is the this of the call to every.

Example:

var isEven = function(x) { return (x % 2) === 0; }
console.log(new Uint8ClampedArray([2, 22, 36]).every(isEven));
console.log(new Uint8ClampedArray([6, 19, 18]).every(isEven));
console.log(new Uint8ClampedArray([5, 19, 17]).every(isEven));

Run

Results:

Spec

fill(value : Number, [start = 0 : Number, [end : Number]]) : Uint8ClampedArray

Fills this[start], this[start + 1], ... this[end - 1] with value. If end is not specified, this.length is used. Returns this.

Example:

var x = new Uint8ClampedArray(5);

console.log(x.fill(7));
console.log(x.fill(8, 3));
console.log(x.fill(9, 0, 2));

Run

Results:

Spec

filter(callback : Function, [thisArg : Object]) : Uint8ClampedArray

callback(item : Number, index : Number, array : Uint8ClampedArray) : Boolean

Returns a new Uint8ClampedArray containing only the items in this that callback returned true for. The Uint8ClampedArray passed to callback is the this of the call to filter.

Example:

var isEven = function(x) { return (x % 2) === 0; }
var numbers = new Uint8ClampedArray([1, 2, 4, 5, 7, 9, 12]);
console.log(numbers.filter(isEven));

Run

Results:

Spec

find(callback : Function, [thisArg : Object]) : Number

callback(item : Number, index : Number, array : Uint8ClampedArray) : Boolean

Returns the first item in this where callback returns true for that item. The Uint8ClampedArray passed to callback is the this of the call to find. See also findIndex().

Example:

var x = new Uint8ClampedArray([10, 11, 12, 13, 14]);

console.log(x.find(function(item) {
  return item > 13;
}));

Run

Results:

Spec

findIndex(callback : Function, [thisArg : Object]) : Number

callback(item : Number, index : Number, array : Uint8ClampedArray) : Boolean

Returns the index of the first item in this where callback returns true for that item. The Uint8ClampedArray passed to callback is the this of the call to find. See also find().

Example:

var x = new Uint8ClampedArray([10, 11, 12, 13, 14]);

console.log(x.findIndex(function(item) {
  return item > 13;
}));

Run

Results:

Spec

forEach(callback : Function, [thisArg : Object]) : undefined

callback(item : Number, index : Number, array : Uint8ClampedArray) : undefined

Calls callback for each item in this. The Uint8ClampedArray passed to callback is the this of the call to forEach.

Example:

var x = new Uint8ClampedArray([7, 8, 9]);
x.forEach(function(item, index) {
  console.log('item at ' + index + ' = ' + item);
});

Run

Results:

Spec

includes(item : Number, [startingIndex = 0 : Number]) : Boolean

Returns true if item is an element of this starting the search from startingIndex. If startingIndex is negative, this.length is added to it before starting the search.

Example:

var x = new Uint8ClampedArray([5, 6, 7, 8, 9]);
console.log(x.includes(7));
console.log(x.includes(6, 2));
console.log(x.includes(8, -2));
console.log(x.includes(10));

Run

Results:

Spec

indexOf(item : Number, [startingIndex = 0 : Number]) : Number

Returns the first location of item in this starting the search from start. If startingIndex is negative, this.length is added to it before starting the search. Returns -1 if item is not found. See also lastIndexOf().

Example:

var x = new Uint8ClampedArray([5, 6, 7, 8, 9, 5, 6]);
console.log(x.indexOf(6));
console.log(x.indexOf(6, 2));
console.log(x.indexOf(5, -2));
console.log(x.indexOf(10, 2));

Run

Results:

Spec

join([separator = ',' : String]) : String

Returns a String created by joining the toString() of each item of this separated by separator.

Example:

var x = new Uint8ClampedArray([7, 8, 9]);
console.log(x.join());
console.log(x.join(' -- '));

Run

Results:

Spec

keys() : Iterator<Number>

Returns an iterator of the indicies in this. See also entries() and values().

Example:

var x = new Uint8ClampedArray([8, 9]);

// Use for (... of ...) to loop over the iterator
for (var key of x.keys()) {
  console.dir(key);
}

// Or access the iterator manually
var keys = x.keys();

console.dir(keys.next());
console.dir(keys.next());
console.dir(keys.next());

Run

Results:

Spec

lastIndexOf(item : Number, [startingIndex : Number]) : Number

Returns the location of item by searchig backwards through this, starting the search from startingIndex. If startingIndex is not specified, the search starts from the end of the array. If startingIndex is negative, this.length is added to it before starting the search. Returns -1 if item is not found. See also indexOf().

Example:

var x = new Uint8ClampedArray([5, 6, 7, 8, 9, 5, 6]);
console.log(x.lastIndexOf(6));
console.log(x.lastIndexOf(6, 2));
console.log(x.lastIndexOf(5, -3));
console.log(x.lastIndexOf(10, 2));

Run

Results:

Spec

map(callback : Function, [thisArg : Object]) : Array

callback(item : Number, index : Number, array : Uint8ClampedArray) : Object

Returns a new Uint8ClampedArray with where each item is the result of calling callback on each item in this. The Uint8ClampedArray passed to callback is the this of the call to map.

Example:

var numbers = new Uint8ClampedArray([1, 2, 3, 4]);
var squares = numbers.map(function(x) { return x * x; });
console.log(squares);
console.log(numbers);

Run

Results:

Spec

reduce(callback : Function, [initialValue : Object]) : Object

callback(previous : Object, current : Number, index : Number, array : Uint8ClampedArray) : Object

Calls callback for each item in this in ascending order (0 to length-1). It passes the return value of callback for the i-1th item as the previous parameter for the ith item. Returns the result from the last call to callback. If initialValue is not specified, callback will first be called on this[1] with previous set to this[0]. The Uint8ClampedArray passed to callback is the this of the call to reduce.

Example:

var x = new Uint8ClampedArray([0, 1, 2, 3, 4]);
var sum = function(prev, cur) { return prev + cur; } 
console.log(x.reduce(sum));

Run

Results:

Spec

reduceRight(callback : Function, [initialValue : Object]) : Object

callback(previous : Object, current : Number, index : Number, array : Uint8ClampedArray) : Object

Calls callback for each item in this in descending order (length-1 to 0). It passes the return value of callback for the i+1th item as the previous parameter for the ith item. Returns the result from the last call to callback. If initialValue is not specified, callback will first be called on this[this.length - 2] with previous set to this[this.length - 1]. The Uint8ClampedArray passed to callback is the this of the call to reduceRight.

Example:

var x = new Uint8ClampedArray([2, 3]);
var pow = function(prev, cur) { return prev ** cur; } 
console.log(x.reduce(pow)); // 2 ** 3
console.log(x.reduceRight(pow)); // 3 ** 2

Run

Results:

Spec

reverse() : Uint8ClampedArray

Reverses the order of the items in this and returns this.

Example:

var x = new  Uint8ClampedArray([1, 2, 3]);
console.log(x.reverse());
console.log(x);

Run

Results:

Spec

set 2 variants

set(array : Array, [offset = 0 : Number]) : undefined

Copies items from array into this starting at this[offset]. Copied items are converted to 8 bit ints before storing in this.

Example:

var x = new Uint8ClampedArray(10);
x.set([18, 93, 42], 3);
console.log(x[3]);
console.log(x[4]);
console.log(x[5]);

Run

Results:

set(array : Uint8ClampedArray, [offset = 0 : Number]) : undefined

Copies items from array into this starting at this[offset]. array can be any of the typed array types and the copied items will be converted to 8 bit ints before storing in this.

Example:

var x = new Uint8ClampedArray(10);
x.set(new Uint8ClampedArray([18, 93, 42]), 3);
console.log(x[3]);
console.log(x[4]);
console.log(x[5]);

Run

Results:

slice(start : Number, [end : Number]) : Uint8ClampedArray

Returns a new Uint8ClampedArray which is composed of the items this[start], this[start + 1], ..., this[end - 1]. Note that item[end] is not included. If start or end is negative, the value is added to this.length before performing the slice. If end is not specified, this.length is used.

Example:

var x = new Uint8ClampedArray([0, 1, 2, 3, 4, 5, 6]);
console.log(x.slice(2));
console.log(x.slice(2, 3));
console.log(x.slice(1, -2));
console.log(x.slice(-4, -1));
console.log(x);

Run

Results:

Spec

some(callback : Function, [thisArg : Object]) : Boolean

callback(item : Number, index : Number, array : Uint8ClampedArray) : Boolean

Returns true if callback returns true for at least one item in this. Otherwise returns false. The Uint8ClampedArray passed to callback is the this of the call to some.

Example:

var isEven = function(x) { return (x % 2) === 0; }
console.log(new Uint8ClampedArray([2, 22, 36]).some(isEven));
console.log(new Uint8ClampedArray([6, 19, 18]).some(isEven));
console.log(new Uint8ClampedArray([5, 19, 17]).some(isEven));

Run

Results:

Spec

sort([comparisonFunction : Function]) : Uint8ClampedArray

comparisonFunction(x : Number, y : Number) : Number

Sort the items of this using comparisonFunction to determine the sort order and returns this. The Number returned by comparisonFunction should be 0 if x and y are equal, negative if x is less than y, or positive if x is greater than y. If comparisonFunction is not specified, the items will be sorted in numeric order. Returns this.

Example:

var x = new Int16Array([52, 7, 14, 22, 9]);

console.log(x.sort());

// Sort evens before odds
var myComparison = function(x, y) {
  var xIsEven = (x % 2 === 0);
  var yIsEven = (y % 2 === 0);
  if (xIsEven !== yIsEven) {
    return xIsEven ? 0 : 1;
  }
  return Math.abs(x) - Math.abs(y);
};
console.log(x.sort(myComparison));

Run

Results:

Spec

subarray(begin : Number, [end : Number]) : Uint8ClampedArray

Returns a new Uint8ClampedArray that is a view on top of this containing items this[begin], this[begin + 1], ..., this[end - 1]. The 0th item in the returned array in the same memory location as this[begin]. If end is not specified, this.length is used.

Example:

var x = new Uint8ClampedArray([0, 1, 2, 3, 4, 5]); // length=6
var y = x.subarray(2, 5);
console.log(y.length);
console.log(y[0]);
console.log(y[1]);
y[0] = 100;
console.log(x[2]);

Run

Results:

values() : Iterator<Number>

Returns an iterator of the items in this. The values function is also returned for this[Symbol.iterator] so you can iterate over this directly to get the values. See also entries() and keys().

Example:

var x = new Uint8ClampedArray([8, 9]);

// values is returned by x[Symbol.iterator] so you can just 
// use x directly in the for (... of ...) loop
for (var value of x) {
  console.dir(value);
}

// You can iterate over values explicitly
for (var value of x.values()) {
  console.dir(value);
}

// Or access the iterator manually
var values = x.values();

console.dir(values.next());
console.dir(values.next());
console.dir(values.next());

Run

Results:

Spec

Uint8ClampedArray Properties

BYTES_PER_ELEMENT : Number

Returns the size in bytes of an item in a Uint8ClampedArray.

Example:

console.log(Uint8ClampedArray.BYTES_PER_ELEMENT);

Run

Results:

home license contribute feedback toggle light/dark mode