test: add tests for method

Author: ahmad-kashkoush

lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.includes.js

@@ -0,0 +1,226 @@
+/**
+* @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 tape = require( 'tape' );
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var isFunction = require( '@stdlib/assert/is-function' );
+var factory = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof factory, 'function', 'main export is a function' );
+	t.end();
+});
+
+tape( 'the function returns a function', function test( t ) {
+	var ctor = factory( 'float64' );
+	t.strictEqual( isFunction( ctor ), true, 'returns expected value' );
+	t.end();
+});
+
+tape( 'attached to the prototype of the returned function is an `includes` method', function test( t ) {
+	var ctor = factory( 'float64' );
+	t.strictEqual( hasOwnProp( ctor.prototype, 'includes' ), true, 'returns expected value' );
+	t.strictEqual( isFunction( ctor.prototype.includes ), true, 'returns expected value' );
+	t.end();
+});
+
+tape( 'the method throws an error if invoked with a `this` context which is not a typed array instance', function test( t ) {
+	var values;
+	var ctor;
+	var arr;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', 5 );
+
+	values = [
+		'5',
+		5,
+		NaN,
+		true,
+		false,
+		null,
+		void 0,
+		{},
+		[],
+		function noop() {}
+	];
+	for ( i = 0; i < values.length; i++ ) {
+		t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+	}
+	t.end();
+
+	function badValue( value ) {
+		return function badValue() {
+			return arr.includes.call( value, 0 );
+		};
+	}
+});
+
+tape( 'the method throws an error if provided a second argument which is not an integer', function test( t ) {
+	var values;
+	var ctor;
+	var arr;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
+
+	values = [
+		'5',
+		3.14,
+		NaN,
+		true,
+		false,
+		null,
+		void 0,
+		{},
+		[],
+		function noop() {}
+	];
+	for ( i = 0; i < values.length; i++ ) {
+		t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+	}
+	t.end();
+
+	function badValue( value ) {
+		return function badValue() {
+			return arr.includes( 1.0, value );
+		};
+	}
+});
+
+tape( 'the method returns `false` if provided a second argument which exceeds array dimensions', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
+
+	for ( i = arr.length; i < arr.length+5; i++ ) {
+		v = arr.includes( 1.0, i );
+		t.strictEqual( v, false, 'returns expected value' );
+	}
+	t.end();
+});
+
+tape( 'the method returns `false` if operating on an empty array', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [] );
+
+	v = arr.includes( 1.0 );
+	t.strictEqual( v, false, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the method returns `false` if a search element is not found', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+	v = arr.includes( 10.0 );
+	t.strictEqual( v, false, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the method returns `true`  if an element is found', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 2.0 ] );
+
+	v = arr.includes( 2.0 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the method supports specifying a starting search index', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 2.0 ] );
+
+	v = arr.includes( 2.0, 0 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	v = arr.includes( 2.0, 2 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	v = arr.includes( 1.0, 4 );
+	t.strictEqual( v, false, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the method supports specifying a starting search index (negative)', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 2.0 ] );
+
+	v = arr.includes( 2.0, -3 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	v = arr.includes( 1.0, -3 );
+	t.strictEqual( v, false, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'when provided a starting index which resolves to an index less than zero, the method searches from the first array element', function test( t ) {
+	var ctor;
+	var arr;
+	var v;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 2.0 ] );
+
+	v = arr.includes( 2.0, -10 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	v = arr.includes( 1.0, -10 );
+	t.strictEqual( v, true, 'returns expected value' );
+
+	t.end();
+});