Add Typescript definition

Planeshifter · Planeshifter · commit c205a7f68e1d · 2019-09-14T16:32:14.000-04:00
diff --git a/lib/node_modules/@stdlib/utils/map-function/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/map-function/docs/types/index.d.ts
@@ -0,0 +1,70 @@
+/*
+* @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
+
+/**
+* Invoked function.
+*
+* @returns result
+*/
+type Nullary = () => any;
+
+/**
+* Invoked function.
+*
+* @param i - invocation index
+* @returns result
+*/
+type Unary = ( i: number ) => any;
+
+/**
+* Invoked function.
+*
+* @param i - invocation index
+* @returns result
+*/
+type Fcn = Nullary | Unary;
+
+/**
+* Invokes a function `n` times and returns an array of accumulated function return values.
+*
+* ## Notes
+*
+* -   The invoked function is provided a single argument: the invocation index (zero-based).
+*
+* @param fcn - function to invoke
+* @param n - number of function invocations
+* @param thisArg - execution context
+* @throws second argument must be a nonnegative integer
+* @returns accumulated results
+*
+* @example
+* function fcn( i ) {
+*     return i;
+* }
+*
+* var arr = mapFun( fcn, 5 );
+* // returns [ 0, 1, 2, 3, 4 ]
+*/
+declare function mapFun( fcn: Fcn, n: number, thisArg?: any ): Array<any>;
+
+
+// EXPORTS //
+
+export = mapFun;
diff --git a/lib/node_modules/@stdlib/utils/map-function/docs/types/test.ts b/lib/node_modules/@stdlib/utils/map-function/docs/types/test.ts
@@ -0,0 +1,61 @@
+/*
+* @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 mapFun = require( './index' );
+
+/**
+* Identity function.
+*/
+function identity( x: any ): any {
+	return x;
+}
+
+
+// TESTS //
+
+// The function return an array of values...
+{
+	mapFun( identity, 5 ); // $ExpectType any[]
+	mapFun( identity, 5, {} ); // $ExpectType any[]
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a function...
+{
+	mapFun( 'abc', 5 ); // $ExpectError
+	mapFun( 5, 5 ); // $ExpectError
+	mapFun( true, 5 ); // $ExpectError
+	mapFun( false, 5 ); // $ExpectError
+	mapFun( [], 5 ); // $ExpectError
+	mapFun( {}, 5 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a number...
+{
+	mapFun( identity, 'abc' ); // $ExpectError
+	mapFun( identity, identity ); // $ExpectError
+	mapFun( identity, true ); // $ExpectError
+	mapFun( identity, false ); // $ExpectError
+	mapFun( identity, [] ); // $ExpectError
+	mapFun( identity, {} ); // $ExpectError
+}
+
+// The function does not compile if provided less than two arguments...
+{
+	mapFun(); // $ExpectError
+	mapFun( identity ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/map-function/package.json b/lib/node_modules/@stdlib/utils/map-function/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
