Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/string/format/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Inserts supplied variable values into a format string.
+*
+* @param str - input string
+* @param ...args - variable values
+* @throws invalid flags
+* @returns formatted string
+*
+* @example
+* var str = format( 'Hello %s!', 'world' );
+* // returns 'Hello world!'
+*
+* @example
+* var str = format( 'Pi: ~%.2f', 3.141592653589793 );
+* // returns 'Pi: ~3.14'
+*/
+declare function format( str: string, ...args: Array<any> ): string;
+
+
+// EXPORTS //
+
+export = format;

lib/node_modules/@stdlib/string/format/docs/types/test.ts

@@ -0,0 +1,45 @@
+/*
+* @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 format = require( './index' );
+
+
+// TESTS //
+
+// The function returns a string...
+{
+	format( 'Hello World!' ); // $ExpectType string
+	format( 'Hello, %s!', 'Jane' ); // $ExpectType string
+}
+
+// The function does not compile if provided a first argument other than a string...
+{
+	format( true ); // $ExpectError
+	format( false ); // $ExpectError
+	format( null ); // $ExpectError
+	format( undefined ); // $ExpectError
+	format( 5 ); // $ExpectError
+	format( [] ); // $ExpectError
+	format( {} ); // $ExpectError
+	format( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	format(); // $ExpectError
+}