@stdlib/utils/none-in-by/docs/types/test.ts

Standard utilities.

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

const isPositive = ( v: number ): boolean => {
	return ( v > 0 );
};

// TESTS //

const obj = {
	'a': 1,
	'b': 2,
	'c': 4
};

// The function returns a boolean...
{
	noneInBy( obj, isPositive ); // $ExpectType boolean
}

// The compiler throws an error if the function is provided a first argument which is not an object...
{
	noneInBy( '2', isPositive ); // $ExpectError
	noneInBy( false, isPositive ); // $ExpectError
	noneInBy( true, isPositive ); // $ExpectError
	noneInBy( [ 1, 2 ], isPositive ); // $ExpectError
}

// The compiler throws an error if the function is provided a second argument which is not a function...
{
	noneInBy( obj, 2 ); // $ExpectError
	noneInBy( obj, false ); // $ExpectError
	noneInBy( obj, true ); // $ExpectError
	noneInBy( obj, 'abc' ); // $ExpectError
	noneInBy( obj, {} ); // $ExpectError
	noneInBy( obj, [] ); // $ExpectError
}

// The compiler throws an error if the function is provided an invalid number of arguments...
{
	noneInBy(); // $ExpectError
	noneInBy( [ 1, 2, 3] ); // $ExpectError
	noneInBy( [ 1, 2, 3], isPositive, {}, 3 ); // $ExpectError
}