/*
* @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.
*/

/* eslint-disable space-in-parens */

import empty = require( './../../../empty' );
import first = require( './index' );


// TESTS //

// The function returns an ndarray...
{
	const sh = [ 2, 2 ];

	first( empty( sh, { 'dtype': 'float64' } ) ); // $ExpectType float64ndarray
	first( empty( sh, { 'dtype': 'float64' } ), {} ); // $ExpectType float64ndarray
	first( empty( sh, { 'dtype': 'float64' } ), { 'dims': [ -1 ] } ); // $ExpectType float64ndarray
	first( empty( sh, { 'dtype': 'complex64' } ), { 'dims': [ 0 ] } ); // $ExpectType complex64ndarray
	first( empty( sh, { 'dtype': 'int32' } ), { 'dims': [ 0, 1 ] } ); // $ExpectType int32ndarray
}

// The compiler throws an error if the function is provided a first argument which is not an ndarray...
{
	first( '10' ); // $ExpectError
	first( 10 ); // $ExpectError
	first( false ); // $ExpectError
	first( true ); // $ExpectError
	first( null ); // $ExpectError
	first( [] ); // $ExpectError
	first( {} ); // $ExpectError
	first( ( x: number ): number => x ); // $ExpectError

	first( '10', {} ); // $ExpectError
	first( 10, {} ); // $ExpectError
	first( false, {} ); // $ExpectError
	first( true, {} ); // $ExpectError
	first( null, {} ); // $ExpectError
	first( [], {} ); // $ExpectError
	first( {}, {} ); // $ExpectError
	first( ( x: number ): number => x, {} ); // $ExpectError
}

// The compiler throws an error if the function is provided a second argument which is not an object...
{
	const x = empty( [ 2, 2 ], { 'dtype': 'float64' } );

	first( x, '10' ); // $ExpectError
	first( x, 10 ); // $ExpectError
	first( x, false ); // $ExpectError
	first( x, true ); // $ExpectError
	first( x, null ); // $ExpectError
	first( x, [] ); // $ExpectError
	first( x, ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided a `dims` option which is not an array-like object of numbers...
{
	const x = empty( [ 2, 2 ], { 'dtype': 'float64' } );

	first( x, { 'dims': '10' } ); // $ExpectError
	first( x, { 'dims': 10 } ); // $ExpectError
	first( x, { 'dims': false } ); // $ExpectError
	first( x, { 'dims': true } ); // $ExpectError
	first( x, { 'dims': null } ); // $ExpectError
	first( x, { 'dims': [ '1' ] } ); // $ExpectError
	first( x, { 'dims': {} } ); // $ExpectError
	first( x, { 'dims': ( x: number ): number => x } ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
	const x = empty( [ 2, 2 ], { 'dtype': 'float64' } );

	first(); // $ExpectError
	first( x, {}, {} ); // $ExpectError
}