Add constant for maximum typed array length

Author: kgryte

lib/node_modules/@stdlib/array/constants/max-typedarray-length/README.md

@@ -0,0 +1,99 @@
+# Maximum Typed Array Length
+
+> Maximum length for a typed array.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var MAX_TYPEDARRAY_LENGTH = require( '@stdlib/array/constants/max-typedarray-length' );
+```
+
+#### MAX_TYPEDARRAY_LENGTH
+
+Maximum length for a typed array.
+
+```javascript
+var len = MAX_TYPEDARRAY_LENGTH;
+// returns 9007199254740991
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable no-new-cap -->
+
+```javascript
+var ctors = require( '@stdlib/array/ctors' );
+var MAX_TYPEDARRAY_LENGTH = require( '@stdlib/array/constants/max-typedarray-length' );
+
+function fill( dtype, len, value ) {
+    var ctor;
+    var arr;
+    var i;
+    if ( len > MAX_TYPEDARRAY_LENGTH ) {
+        throw new RangeError( 'invalid input argument. The maximum length for a typed array is '+MAX_TYPEDARRAY_LENGTH+'.' );
+    }
+    ctor = ctors( dtype );
+    arr = new ctor( len );
+    for ( i = 0; i < len; i++ ) {
+        arr[ i ] = value;
+    }
+    return arr;
+}
+
+var arr = fill( 'float64', 10, 3.14 );
+console.log( arr );
+
+try {
+    arr = fill( 'float64', 1e300, 3.14 );
+} catch ( err ) {
+    console.error( err.message );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/array/constants/max-typedarray-length/docs/repl.txt

@@ -0,0 +1,12 @@
+
+{{alias}}
+    Maximum length for a typed array.
+
+    Examples
+    --------
+    > {{alias}}
+    9007199254740991
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/array/constants/max-typedarray-length/examples/index.js

@@ -0,0 +1,28 @@
+'use strict';
+
+var ctors = require( '@stdlib/array/ctors' );
+var MAX_TYPEDARRAY_LENGTH = require( './../lib' );
+
+function fill( dtype, len, value ) {
+	var ctor;
+	var arr;
+	var i;
+	if ( len > MAX_TYPEDARRAY_LENGTH ) {
+		throw new RangeError( 'invalid input argument. The maximum length for a typed array is '+MAX_TYPEDARRAY_LENGTH+'.' );
+	}
+	ctor = ctors( dtype );
+	arr = new ctor( len ); // eslint-disable-line no-new-cap
+	for ( i = 0; i < len; i++ ) {
+		arr[ i ] = value;
+	}
+	return arr;
+}
+
+var arr = fill( 'float64', 10, 3.14 );
+console.log( arr );
+
+try {
+	arr = fill( 'float64', 1e300, 3.14 );
+} catch ( err ) {
+	console.error( err.message );
+}

lib/node_modules/@stdlib/array/constants/max-typedarray-length/lib/index.js

@@ -0,0 +1,31 @@
+'use strict';
+
+/**
+* Maximum length of a typed array.
+*
+* @module @stdlib/array/constants/max-typed-array-length
+*
+* @example
+* var MAX_TYPEDARRAY_LENGTH = require( '@stdlib/array/constants/max-typedarray-length' );
+* // returns 9007199254740991
+*/
+
+// MAIN //
+
+/**
+* Maximum length of a typed array.
+*
+* ```tex
+* 2^{53} - 1
+* ```
+*
+* @constant
+* @type {uinteger}
+* @default 9007199254740991
+*/
+var MAX_TYPEDARRAY_LENGTH = 9007199254740991;
+
+
+// EXPORTS //
+
+module.exports = MAX_TYPEDARRAY_LENGTH;

lib/node_modules/@stdlib/array/constants/max-typedarray-length/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@stdlib/array/constants/max-typedarray-length",
+  "version": "0.0.0",
+  "description": "Maximum length for a typed array.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "constant",
+    "const",
+    "length",
+    "len",
+    "typed",
+    "array",
+    "typed-array",
+    "typed array",
+    "maximum",
+    "max"
+  ]
+}

lib/node_modules/@stdlib/array/constants/max-typedarray-length/test/test.js

@@ -0,0 +1,20 @@
+'use strict';
+
+// MODULES //
+
+var tape = require( 'tape' );
+var MAX_TYPEDARRAY_LENGTH = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a number', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof MAX_TYPEDARRAY_LENGTH, 'number', 'main export is a number' );
+	t.end();
+});
+
+tape( 'the exported value is 9007199254740991', function test( t ) {
+	t.strictEqual( MAX_TYPEDARRAY_LENGTH, 9007199254740991, 'returns expected value' );
+	t.end();
+});