@stdlib/assert-is-complex-typed-array-like
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isComplexTypedArrayLike

    NPM version Build Status Coverage Status

    Test if a value is complex-typed-array-like.

    Installation

    npm install @stdlib/assert-is-complex-typed-array-like

    Usage

    var isComplexTypedArrayLike = require( '@stdlib/assert-is-complex-typed-array-like' );

    isComplexTypedArrayLike( value )

    Tests if a value is complex-typed-array-like.

    var Complex64Array = require( '@stdlib/array-complex64' );
    
    var bool = isComplexTypedArrayLike( new Complex64Array() );
    // returns true
    
    bool = isComplexTypedArrayLike({
        'length': 10,
        'byteOffset': 0,
        'byteLength': 10,
        'BYTES_PER_ELEMENT': 4,
        'get': function get() {},
        'set': function set() {}
    });
    // returns true

    Examples

    var Complex64Array = require( '@stdlib/array-complex64' );
    var isComplexTypedArrayLike = require( '@stdlib/assert-is-complex-typed-array-like' );
    
    var bool;
    var arr;
    
    arr = {
        'BYTES_PER_ELEMENT': 8,
        'length': 10,
        'byteOffset': 0,
        'byteLength': 10,
        'get': function get() {},
        'set': function set() {}
    };
    bool = isComplexTypedArrayLike( arr );
    // returns true
    
    bool = isComplexTypedArrayLike( new Complex64Array( 4 ) );
    // returns true
    
    bool = isComplexTypedArrayLike( [] );
    // returns false
    
    bool = isComplexTypedArrayLike( {} );
    // returns false
    
    bool = isComplexTypedArrayLike( null );
    // returns false
    
    bool = isComplexTypedArrayLike( 'beep' );
    // returns false
    
    bool = isComplexTypedArrayLike( function foo( a, b ) {} );
    // returns false

    See Also


    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-complex-typed-array-like

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    38

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    40.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser