@stdlib/string/uppercase/docs/types/test.ts

String manipulation 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 uppercase = require( './index' );


// TESTS //

// The function returns a string...
{
	uppercase( 'Last man standing' ); // $ExpectType "LAST MAN STANDING"
	uppercase( 'Hello World!' ); // $ExpectType "HELLO WORLD!"
	uppercase( 'beep' ); // $ExpectType "BEEP"
	uppercase( 'BOOP' ); // $ExpectType "BOOP"
	uppercase( 'foo' as string ); // $ExpectType string
}

// The compiler throws an error if the function is provided a value other than a string...
{
	uppercase( true ); // $ExpectError
	uppercase( false ); // $ExpectError
	uppercase( null ); // $ExpectError
	uppercase( undefined ); // $ExpectError
	uppercase( 5 ); // $ExpectError
	uppercase( [] ); // $ExpectError
	uppercase( {} ); // $ExpectError
	uppercase( ( x: number ): number => x ); // $ExpectError
}

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