feat: add array/base/assert/is-byte-order

lib/node_modules/@stdlib/array/base/assert/is-byte-order/README.md

@@ -0,0 +1,117 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# isByteOrder
+
+> Test if an input value is a supported array byte order.
+
+<!-- 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 isByteOrder = require( '@stdlib/array/base/assert/is-byte-order' );
+```
+
+#### isByteOrder( value )
+
+Tests if an input `value` is a supported array byte order.
+
+```javascript
+var bool = isByteOrder( 'little-endian' );
+// returns true
+
+bool = isByteOrder( 'big-endian' );
+// returns true
+```
+
+</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 no-undef: "error" -->
+
+```javascript
+var isByteOrder = require( '@stdlib/array/base/assert/is-byte-order' );
+
+var bool = isByteOrder( 'little-endian' );
+// returns true
+
+bool = isByteOrder( 'big-endian' );
+// returns true
+
+bool = isByteOrder( '' );
+// returns false
+
+bool = isByteOrder( 'foo' );
+// returns false
+```
+
+</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 related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- 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/base/assert/is-byte-order/benchmark/benchmark.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var isByteOrder = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var out;
+	var v;
+	var i;
+
+	values = [
+		'little-endian',
+		'big-endian',
+		'foo',
+		'bar',
+		'',
+		'beep',
+		'boop'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = values[ i%values.length ];
+		out = isByteOrder( v );
+		if ( typeof out !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( out ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/array/base/assert/is-byte-order/docs/repl.txt

@@ -0,0 +1,28 @@
+
+{{alias}}( value )
+    Tests if an input value is a supported array byte order.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating if an input value is a supported array byte order.
+
+    Examples
+    --------
+    > var bool = {{alias}}( 'little-endian' )
+    true
+    > bool = {{alias}}( 'big-endian' )
+    true
+    > bool = {{alias}}( '' )
+    false
+    > bool = {{alias}}( 'beep' )
+    false
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/array/base/assert/is-byte-order/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Tests whether an input value is a supported array byte order.
+*
+* @param v - value to test
+* @returns boolean indicating whether an input value is a supported array byte order
+*
+* @example
+* var bool = isByteOrder( 'little-endian' );
+* // returns true
+*
+* bool = isByteOrder( 'big-endian' );
+* // returns true
+*
+* bool = isByteOrder( 'foo' );
+* // returns false
+*/
+declare function isByteOrder( v: any ): boolean;
+
+
+// EXPORTS //
+
+export = isByteOrder;

lib/node_modules/@stdlib/array/base/assert/is-byte-order/docs/types/test.ts

@@ -0,0 +1,34 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import isByteOrder = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isByteOrder( 'little-endian' ); // $ExpectType boolean
+	isByteOrder( 'foo' ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isByteOrder(); // $ExpectError
+	isByteOrder( undefined, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/array/base/assert/is-byte-order/examples/index.js

@@ -0,0 +1,37 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var isByteOrder = require( './../lib' );
+
+var bool = isByteOrder( 'little-endian' );
+console.log( bool );
+// => true
+
+bool = isByteOrder( 'big-endian' );
+console.log( bool );
+// => true
+
+bool = isByteOrder( '' );
+console.log( bool );
+// => false
+
+bool = isByteOrder( 'foo' );
+console.log( bool );
+// => false

lib/node_modules/@stdlib/array/base/assert/is-byte-order/lib/index.js

@@ -0,0 +1,46 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/**
+* Test whether an input value is a supported array byte order.
+*
+* @module @stdlib/array/base/assert/is-byte-order
+*
+* @example
+* var isByteOrder = require( '@stdlib/array/base/assert/is-byte-order' );
+*
+* var bool = isByteOrder( 'little-endian' );
+* // returns true
+*
+* bool = isByteOrder( 'big-endian' );
+* // returns true
+*
+* bool = isByteOrder( 'foo' );
+* // returns false
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;