@stdlib/utils/shift/docs/types/test.ts

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


// TESTS //

// The function returns the input collection and the removed element...
{
	shift( [ 2, 3 ] ); // $ExpectType [Collection<number>, number]
	shift( [ 'a', 'b', 'c' ] ); // $ExpectType [Collection<string>, string]
	shift( [ true, false ] ); // $ExpectType [Collection<boolean>, boolean]
	shift( [ true, true ] ); // $ExpectType [Collection<boolean>, boolean]
}

// The compiler throws an error if the function is provided a value other than a collection...
{
	shift( true ); // $ExpectError
	shift( false ); // $ExpectError
	shift( 5 ); // $ExpectError
}

// The compiler throws an error if the function is not provided one argument...
{
	shift(); // $ExpectError
	shift( [ true, true ], 1 ); // $ExpectError
}