Add Typescript definition

Planeshifter · Planeshifter · commit 86c209df0128 · 2019-02-02T15:53:12.000-05:00
diff --git a/lib/node_modules/@stdlib/string/repeat/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/repeat/docs/types/index.d.ts
@@ -0,0 +1,45 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Repeats a string `n` times and returns the concatenated result.
+*
+* @param str - string to repeat
+* @param n - number of times to repeat the string
+* @returns repeated string
+*
+* @example
+* var str = repeat( 'a', 5 );
+* // returns 'aaaaa'
+*
+* @example
+* var str = repeat( '', 100 );
+* // returns ''
+*
+* @example
+* var str = repeat( 'beep', 0 );
+* // returns ''
+*/
+declare function repeat( str: string, n: number ): string;
+
+
+// EXPORTS //
+
+export = repeat;
diff --git a/lib/node_modules/@stdlib/string/repeat/docs/types/test.ts b/lib/node_modules/@stdlib/string/repeat/docs/types/test.ts
@@ -0,0 +1,57 @@
+/*
+* @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 repeat = require( './index' );
+
+
+// TESTS //
+
+// The function returns a string...
+{
+	repeat( 'a', 2 ); // $ExpectType string
+}
+
+// The function does not compile if provided values other than a string and a number...
+{
+	repeat( true, 3 ); // $ExpectError
+	repeat( false, 2 ); // $ExpectError
+	repeat( 3, 1 ); // $ExpectError
+	repeat( [], 1 ); // $ExpectError
+	repeat( {}, 2 ); // $ExpectError
+	repeat( ( x: number ): number => x, 2 ); // $ExpectError
+
+	repeat( 'a', true ); // $ExpectError
+	repeat( 'a', false ); // $ExpectError
+	repeat( 'a', '5' ); // $ExpectError
+	repeat( 'a', [] ); // $ExpectError
+	repeat( 'a', {} ); // $ExpectError
+	repeat( 'a', ( x: number ): number => x ); // $ExpectError
+
+	repeat( [], true ); // $ExpectError
+	repeat( {}, false ); // $ExpectError
+	repeat( false, '5' ); // $ExpectError
+	repeat( {}, [] ); // $ExpectError
+	repeat( '5', ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	repeat(); // $ExpectError
+	repeat( 3 ); // $ExpectError
+	repeat( 'abc' ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/string/repeat/package.json b/lib/node_modules/@stdlib/string/repeat/package.json
@@ -25,6 +25,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
