@stdlib/string/base/uncapitalize/docs/types/test.ts

String manipulation functions.

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


// TESTS //

// The function returns a string...
{
	uncapitalize( 'Last man standing' ); // $ExpectType "last man standing"
	uncapitalize( 'Hello World!' ); // $ExpectType "hello World!"
	uncapitalize( 'BeepBoop' ); // $ExpectType "beepBoop"
	uncapitalize( 'A' ); // $ExpectType "a"
	uncapitalize( 'foo' as string ); // $ExpectType string
}

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

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