@stdlib/time/seconds-in-year/docs/types/test.ts

Time 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 secondsInYear = require( './index' );


// TESTS //

// The function returns a number...
{
	secondsInYear( new Date() ) ; // $ExpectType number
	secondsInYear( 1990 ); // $ExpectType number
	secondsInYear(); // $ExpectType number
}

// The compiler throws an error if the function is provided an argument of invalid type...
{
	secondsInYear( [] ); // $ExpectError
	secondsInYear( {} ); // $ExpectError
	secondsInYear( false ); // $ExpectError
	secondsInYear( true ); // $ExpectError
	secondsInYear( ( x: number ): number => x ); // $ExpectError
	secondsInYear( 'beep' ); // $ExpectError
}

// The compiler throws an error if the function is provided more than one argument...
{
	secondsInYear( 1990, 9 ); // $ExpectError
	secondsInYear( 1990, 1, 19 ); // $ExpectError
}