@stdlib/stats/iter/mmean/docs/types/test.ts

Standard library statistical functions.

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

/**
* Returns an iterator protocol-compliant object.
*
* @returns iterator protocol-compliant object
*/
function iterator() {
	return {
		'next': next
	};

	/**
	* Implements the iterator protocol `next` method.
	*
	* @returns iterator protocol-compliant object
	*/
	function next() {
		return {
			'value': true,
			'done': false
		};
	}
}


// TESTS //

// The function returns an iterator...
{
	itermmean( iterator(), 3 ); // $ExpectType Iterator
}

// The compiler throws an error if the function is provided a first argument which is not an iterator protocol-compliant object...
{
	itermmean( '5', 3 ); // $ExpectError
	itermmean( 5, 3 ); // $ExpectError
	itermmean( true, 3 ); // $ExpectError
	itermmean( false, 3 ); // $ExpectError
	itermmean( null, 3 ); // $ExpectError
	itermmean( undefined, 3 ); // $ExpectError
	itermmean( [], 3 ); // $ExpectError
	itermmean( {}, 3 ); // $ExpectError
	itermmean( ( x: number ): number => x, 3 ); // $ExpectError
}

// The compiler throws an error if the function is provided a second argument which is not a positive integer...
{
	itermmean( iterator(), '5' ); // $ExpectError
	itermmean( iterator(), true ); // $ExpectError
	itermmean( iterator(), false ); // $ExpectError
	itermmean( iterator(), null ); // $ExpectError
	itermmean( iterator(), undefined ); // $ExpectError
	itermmean( iterator(), [] ); // $ExpectError
	itermmean( iterator(), {} ); // $ExpectError
	itermmean( iterator(), ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided insufficient arguments...
{
	itermmean(); // $ExpectError
	itermmean( iterator() ); // $ExpectError
	itermmean( iterator(), 3, 3 ); // $ExpectError
}