test.entries.js

/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 hasProp = require( '@stdlib/assert/has-property' );
var isFunction = require( '@stdlib/assert/is-function' );
var isArray = require( '@stdlib/assert/is-array' );
var Float32Array = require( './../lib' );


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.strictEqual( typeof Float32Array, 'function', 'main export is a function' );
	t.end();
});

tape( 'a typed array instance has an `entries` method for returning an iterator for iterating over array key-value pairs', function test( t ) {
	var arr = new Float32Array( 2 );
	t.strictEqual( hasProp( arr, 'entries' ), true, 'has property' );
	t.strictEqual( isFunction( arr.entries ), true, 'has method' );
	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 arr;
	var i;

	arr = new Float32Array( 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.entries.call( value );
		};
	}
});

tape( 'the method returns an iterator protocol-compliant object', function test( t ) {
	var arr;
	var it;
	var v;
	var i;

	arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );

	it = arr.entries();
	t.strictEqual( typeof it.next, 'function', 'has next method' );

	for ( i = 0; i < arr.length; i++ ) {
		v = it.next();
		t.strictEqual( isArray( v.value ), true, 'returns expected value' );
		t.strictEqual( v.value[ 0 ], i, 'returns expected index' );
		t.strictEqual( v.value[ 1 ], arr[ i ], 'returns expected value' );
		t.strictEqual( typeof v.done, 'boolean', 'returns expected value' );
	}
	t.end();
});

tape( 'the method returns an iterator which indicates completion once all elements have been iterated', function test( t ) {
	var arr;
	var it;
	var v;

	arr = new Float32Array( [ 1.0, 2.0 ] );
	it = arr.entries();

	v = it.next();
	t.strictEqual( v.done, false, 'returns expected value' );

	v = it.next();
	t.strictEqual( v.done, false, 'returns expected value' );

	v = it.next();
	t.strictEqual( v.done, true, 'returns expected value' );
	t.strictEqual( v.value, void 0, 'returns expected value' );

	t.end();
});