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


// TESTS //

// The function returns a string...
{
	capitalize( 'abc' ); // $ExpectType "Abc"
	capitalize( 'beep boop' ); // $ExpectType "Beep boop"
	capitalize( 'a' ); // $ExpectType "A"
	capitalize( 'A' ); // $ExpectType "A"
	capitalize( 'abc' as string ); // $ExpectType string
}

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

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