README

Uint8ClampedArray

Validates if a value is a Uint8ClampedArray.

Installation

$ npm install validate.io-uint8array-clamped

For use in the browser, use browserify.

Usage

var isUint8ClampedArray = require( 'validate.io-uint8array-clamped' );

isUint8ClampedArray( value )

Validates if a value is an Uint8ClampedArray.

var arr = new Uint8ClampedArray( 10 );

var bool = isUint8ClampedArray( arr );
// returns true

Examples

var isUint8ClampedArray = require( 'validate.io-uint8array-clamped' );

console.log( isUint8ClampedArray( new Uint8ClampedArray( 10 ) ) );
// returns true

console.log( isUint8ClampedArray( new Int8Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Uint8Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Int16Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Uint16Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Int32Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Uint32Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Float32Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Float64Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( new Array( 10 ) ) );
// returns false

console.log( isUint8ClampedArray( {} ) );
// returns false

console.log( isUint8ClampedArray( null ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

validate.io-uint8array-clamped

Usage no npm install needed!