@stdlib/string/base/left-pad/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 lpad = require( './index' );


// TESTS //

// The function returns a string...
{
	lpad( 'abd', 5, ' ' ); // $ExpectType string
	lpad( 'abd', 4, 'x' ); // $ExpectType string
}

// The compiler throws an error if the function is provided arguments having invalid types...
{
	lpad( true, 6, ' ' ); // $ExpectError
	lpad( false, 6, ' ' ); // $ExpectError
	lpad( 3, 6, ' ' ); // $ExpectError
	lpad( [], 6, ' ' ); // $ExpectError
	lpad( {}, 6, ' ' ); // $ExpectError
	lpad( ( x: number ): number => x, 6, ' ' ); // $ExpectError

	lpad( 'abd', true, ' ' ); // $ExpectError
	lpad( 'abd', false, ' ' ); // $ExpectError
	lpad( 'abd', 'abc', ' ' ); // $ExpectError
	lpad( 'abd', [], 0, ' ' ); // $ExpectError
	lpad( 'abd', {}, 0, ' ' ); // $ExpectError
	lpad( 'abd', ( x: number ): number => x, 0, ' ' ); // $ExpectError

	lpad( 'abd', 6, true ); // $ExpectError
	lpad( 'abd', 6, false ); // $ExpectError
	lpad( 'abd', 6, 123 ); // $ExpectError
	lpad( 'abd', 6, [] ); // $ExpectError
	lpad( 'abd', 6, {} ); // $ExpectError
	lpad( 'abd', 6, /[a-z]/ ); // $ExpectError
}

// The compiler throws an error if the function is provided insufficient arguments...
{
	lpad(); // $ExpectError
	lpad( 'abc' ); // $ExpectError
	lpad( 'abc', 6 ); // $ExpectError
}