@stdlib/constants-array-max-array-length

Maximum Array Length

Maximum length for a generic array.

Installation

npm install @stdlib/constants-array-max-array-length

Usage

var MAX_ARRAY_LENGTH = require( '@stdlib/constants-array-max-array-length' );

MAX_ARRAY_LENGTH

Maximum length for a generic array.

var len = MAX_ARRAY_LENGTH;
// returns 4294967295

Examples

var MAX_ARRAY_LENGTH = require( '@stdlib/constants-array-max-array-length' );

function alloc( len ) {
    var arr;
    var i;
    if ( len > MAX_ARRAY_LENGTH ) {
        throw new RangeError( 'invalid argument. The maximum length for a generic array is '+MAX_ARRAY_LENGTH+'. To create a longer array-like data structure, consider either typed arrays or an array-like object.' );
    }
    // Manually allocate to ensure "fast" elements...
    arr = [];
    for ( i = 0; i < len; i++ ) {
        arr.push( 0 );
    }
    return arr;
}

var arr = alloc( 10 );
console.log( arr );

try {
    arr = alloc( 1e300 );
} catch ( err ) {
    console.error( err.message );
}

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.

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.1 (2021-06-14)

No changes reported for this release.

</section> <!-- /.release -->