Add Typescript definition

Planeshifter · Planeshifter · commit 156498436db0 · 2019-02-02T15:49:34.000-05:00
diff --git a/lib/node_modules/@stdlib/string/reverse/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/reverse/docs/types/index.d.ts
@@ -0,0 +1,48 @@
+/*
+* @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
+
+/**
+* Reverses a string.
+*
+* @param str - input string
+* @returns reversed string
+*
+* @example
+* var out = reverse( 'last man standing' );
+* // returns 'gnidnats nam tsal'
+*
+* @example
+* var out = reverse( 'presidential election' );
+* // returns 'noitcele laitnediserp'
+*
+* @example
+* var out = reverse( 'javaScript' );
+* // returns 'tpircSavaj'
+*
+* @example
+* var out = reverse( 'Hidden Treasures' );
+* // returns 'serusaerT neddiH'
+*/
+declare function reverse( str: string ): string;
+
+
+// EXPORTS //
+
+export = reverse;
diff --git a/lib/node_modules/@stdlib/string/reverse/docs/types/test.ts b/lib/node_modules/@stdlib/string/reverse/docs/types/test.ts
@@ -0,0 +1,44 @@
+/*
+* @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 reverse = require( './index' );
+
+
+// TESTS //
+
+// The function returns a string...
+{
+	reverse( 'last man standing' ); // $ExpectType string
+}
+
+// The function does not compile if provided a value other than a number...
+{
+	reverse( true ); // $ExpectError
+	reverse( false ); // $ExpectError
+	reverse( null ); // $ExpectError
+	reverse( undefined ); // $ExpectError
+	reverse( 5 ); // $ExpectError
+	reverse( [] ); // $ExpectError
+	reverse( {} ); // $ExpectError
+	reverse( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	reverse(); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/string/reverse/package.json b/lib/node_modules/@stdlib/string/reverse/package.json
@@ -25,6 +25,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
