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

    0.0.8 • Public • Published

    isArrayLength

    NPM version Build Status Coverage Status

    Test if a value is a valid array length.

    Installation

    npm install @stdlib/assert-is-array-length

    Usage

    var isArrayLength = require( '@stdlib/assert-is-array-length' );

    isArrayLength( value )

    Tests if a value is a valid array length.

    var bool = isArrayLength( 5 );
    // returns true
    
    bool = isArrayLength( -1 );
    // returns false
    
    bool = isArrayLength( 2.0e200 );
    // returns false
    
    bool = isArrayLength( 3.14 );
    // returns false
    
    bool = isArrayLength( null );
    // returns false

    Notes

    • A valid length property for an Array is any integer value on the interval [0, 2^32-1].

    Examples

    var isArrayLength = require( '@stdlib/assert-is-array-length' );
    
    var bool = isArrayLength( 5 );
    // returns true
    
    bool = isArrayLength( 0 );
    // returns true
    
    bool = isArrayLength( 2.0e200 );
    // returns false
    
    bool = isArrayLength( 5.256 );
    // returns false
    
    bool = isArrayLength( 1.0/0.0 );
    // returns false
    
    bool = isArrayLength( -1.0/0.0 );
    // returns false
    
    bool = isArrayLength( NaN );
    // returns false
    
    bool = isArrayLength( '5' );
    // returns false
    
    bool = isArrayLength( null );
    // 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-array-length

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    16

    Version

    0.0.8

    License

    Apache-2.0

    Unpacked Size

    36.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser