Not Pictured: Mangoes

    validate.io-typed-array-like

    1.0.1 • Public • Published

    typed-array-like

    NPM version Build Status Coverage Status Dependencies

    Validates if a value is typed-array-like.

    Installation

    $ npm install validate.io-typed-array-like

    For use in the browser, use browserify.

    Usage

    var isTypedArrayLike = require( 'validate.io-typed-array-like' );

    isTypedArrayLike( value )

    Validates if a value is typed-array-like.

    var bool;
     
    bool = isTypedArrayLike( new Int16Array() );
    // returns true
     
    bool = isTypedArrayLike({
        'length': 10,
        'byteOffset': 0,
        'byteLength': 10,
        'BYTES_PER_ELEMENT': 4
    });
    // returns true

    Examples

    var isTypedArrayLike = require( 'validate.io-typed-array-like' );
     
    var arr = {
        'BYTES_PER_ELEMENT': 8,
        'length': 10,
        'byteOffset': 0,
        'byteLength': 10
    };
    console.log( isTypedArrayLike( arr ) );
    // returns true
     
    console.log( isTypedArrayLike( new Int8Array( 4 ) ) );
    // returns true
     
    console.log( isTypedArrayLike( [] ) );
    // returns false
     
    console.log( isTypedArrayLike( {} ) );
    // returns false
     
    console.log( isTypedArrayLike( null ) );
    // returns false
     
    console.log( isTypedArrayLike( 'beep' ) );
    // returns false
     
    console.log( isTypedArrayLike( function foo( a, b ) {} ) );
    // 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.

    Copyright

    Copyright © 2015-2016. Athan Reines.

    Install

    npm i validate.io-typed-array-like

    DownloadsWeekly Downloads

    186

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • kgryte