/**
* @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 forEachRight = require( './index' );

/**
* Callback function.
*
* @param v - argument
* @returns result
*/
function clbk( v: string ): string {
	return v;
}


// TESTS //

// The function returns a string...
{
	forEachRight( 'presidential election', clbk ); // $ExpectType string
	forEachRight( 'Iñtërnâtiônàlizætiøn', clbk, {} ); // $ExpectType string
}

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

	forEachRight( 1, clbk, {} ); // $ExpectError
	forEachRight( false, clbk, {} ); // $ExpectError
	forEachRight( true, clbk, {} ); // $ExpectError
	forEachRight( null, clbk, {} ); // $ExpectError
	forEachRight( [], clbk, {} ); // $ExpectError
	forEachRight( {}, clbk, {} ); // $ExpectError
	forEachRight( ( x: number ): number => x, clbk, {} ); // $ExpectError
}

// The compiler throws an error if the function is provided a second argument which is not a function having a supported signature...
{
	forEachRight( 'presidential election', 'abc' ); // $ExpectError
	forEachRight( 'presidential election', 2 ); // $ExpectError
	forEachRight( 'presidential election', true ); // $ExpectError
	forEachRight( 'presidential election', false ); // $ExpectError
	forEachRight( 'presidential election', null ); // $ExpectError
	forEachRight( 'presidential election', {} ); // $ExpectError
	forEachRight( 'presidential election', [] ); // $ExpectError

	forEachRight( 'presidential election', 'abc', {} ); // $ExpectError
	forEachRight( 'presidential election', 2, {} ); // $ExpectError
	forEachRight( 'presidential election', true, {} ); // $ExpectError
	forEachRight( 'presidential election', false, {} ); // $ExpectError
	forEachRight( 'presidential election', null, {} ); // $ExpectError
	forEachRight( 'presidential election', {}, {} ); // $ExpectError
	forEachRight( 'presidential election', [], {} ); // $ExpectError

	forEachRight( 'presidential election', ( x: number ): number => x ); // $ExpectError
	forEachRight( 'presidential election', ( x: number ): number => x, {} ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
	forEachRight(); // $ExpectError
	forEachRight( 'presidential election' ); // $ExpectError
	forEachRight( 'presidential election', clbk, {}, 3 ); // $ExpectError
}
