@stdlib/assert/is-probability-array/docs/types/test.ts

Standard assertion utilities.

/*
* @license Apache-2.0
*
* Copyright (c) 2019 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 isProbabilityArray = require( './index' );


// TESTS //

// The function returns a boolean...
{
	isProbabilityArray( [ 0.5 ] ); // $ExpectType boolean
	isProbabilityArray( [ -2 ] ); // $ExpectType boolean
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
	isProbabilityArray(); // $ExpectError
	isProbabilityArray( [ 0.2 ], 10.23 ); // $ExpectError
}

// Attached to main export is a `primitives` method which returns a boolean...
{
	// eslint-disable-next-line no-new-wrappers
	isProbabilityArray.primitives( [ new Number( 0.2 ) ] ); // $ExpectType boolean
	isProbabilityArray.primitives( [ 0.2 ] ); // $ExpectType boolean
}

// The compiler throws an error if the `primitives` method is provided an unsupported number of arguments...
{
	isProbabilityArray.primitives(); // $ExpectError
	isProbabilityArray.primitives( [ 0.2 ], 123 ); // $ExpectError
}

// Attached to main export is an `objects` method which returns a boolean...
{
	// eslint-disable-next-line no-new-wrappers
	isProbabilityArray.objects( [ new Number( 0.2 ) ] ); // $ExpectType boolean
	isProbabilityArray.objects( [ 0.2 ] ); // $ExpectType boolean
}

// The compiler throws an error if the `objects` method is provided an unsupported number of arguments...
{
	isProbabilityArray.objects(); // $ExpectError
	isProbabilityArray.objects( [ 0.2 ], 123 ); // $ExpectError
}