Utility Library for Comparing Uint8ClampedArrays
Installation
npm install uint8clampedarray-utils
yarn add uint8clampedarray-utils
Usage
isEqual
Check if two values are equal Uint8ClampedArrays.
=> Promise
// Promise is resolved if equal const a = 1 2 3; const b = 1 2 3; await // => true; // Promise is rejected on difference const a = 1 2 3; const b = 3 2 1; await // => throws Error; // Promise is rejected when called with non Uint8ClampedArray value const a = 1 2 3; const b = 1 2 3;; await // => throws Error;
isEqualSync
Check if two values are equal Uint8ClampedArrays.
=> Boolean
// Returns true/false const a = 1 2 3; const b = 1 2 3; // => true // Pass flag to throw error on invalid arguments/difference const a = 1 2 3; const b = 1 2 3 4; const throwError = true; // => throws Error
diff
Calculate difference between two Uint8ClampedArray.
=> Promise
// Promise is resolved with statistics object const a = 1 2 3 4; const b = 1 2 3 5; await // => { diffCount: 1, diffPercentage: 25 } // Set the step size to 4 if you want to check for pixel differences in RGBA array const a = 0 0 0 0 255 36 17 50; const b = 0 0 0 0 0 0 0 0; const stepSize = 4; await // => { diffCount: 1, diffPercentage: 50 } // Promise is rejected on difference in length const a = 1 2 3; const b = 1 2 3 4; await // => throws Error; // Promise is rejected when called with non Uint8ClampedArray value const a = 1 2 3; const b = 1 2 3;; await // => throws Error;
diffSync
Calculate difference between two Uint8ClampedArray.
=> Object
// Returns statistics object const a = 1 2 3 4; const b = 1 2 3 5; // => { diffCount: 1, diffPercentage: 25 } // Set the step size to 4 if you want to check for pixel differences in RGBA array const a = 0 0 0 0 255 36 17 50; const b = 0 0 0 0 0 0 0 0; const stepSize = 4; // => { diffCount: 1, diffPercentage: 50 } // Throws Error on difference in length const a = 1 2 3; const b = 1 2 3 4; // => throws Error; // Throws Error when called with non Uint8ClampedArray value const a = 1 2 3; const b = 1 2 3;; // => throws Error;
isUint8ClampedArray
Check if value is Uint8ClampedArray. Basically a wrapper for value instanceof Uint8ClampedArray
.
=> Boolean
// Returns true/false const arr = 1 2 3; const uArr = 1 2 3; // => false // => true
hasSameLength
Check if two Uint8ClampedArrays have the same length. Basically a wrapper for a.length === b.length
.
=> Boolean
// Returns true/false const a = 1 2 3; const b = 1 2 3; // => true // Returns false when called with non Uint8ClampedArray value const a = 1 2 3; const b = 1 2 3; // => false // Pass flag to throw error when called with non Uint8ClampedArray value const a = 1 2 3; const b = 1 2 3; const throwError = true; // => throws Error
Running the tests
yarn test
yarn coverage
yarn lint
Support
Please open an issue for support.
License
MIT