Add Typescript definition

Planeshifter · Planeshifter · commit 3f5e275da2a4 · 2019-08-25T23:03:44.000-07:00
diff --git a/lib/node_modules/@stdlib/utils/compose/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/compose/docs/types/index.d.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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Function composition.
+*
+* ## Notes
+*
+* -   Returns a composite function. Starting from the right, the composite function evaluates each function and passes the result as an argument to the next function. The result of the leftmost function is the result of the whole.
+* -   Only the rightmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as unary functions.
+* -   The function will throw if provided fewer than two input arguments.
+*
+* @param fcn - functions to compose
+* @throws must provide more than one argument
+* @returns composite function
+*
+* @example
+* function a( x ) {
+*     return 2 * x;
+* }
+*
+* function b( x ) {
+*     return x + 3;
+* }
+*
+* function c( x ) {
+*     return x / 5;
+* }
+*
+* var f = compose( c, b, a );
+*
+* var z = f( 6 );
+* // returns 3
+*/
+declare function compose( ...fcn: Array<Function> ): Function;
+
+
+// EXPORTS //
+
+export = compose;
diff --git a/lib/node_modules/@stdlib/utils/compose/docs/types/test.ts b/lib/node_modules/@stdlib/utils/compose/docs/types/test.ts
@@ -0,0 +1,63 @@
+/*
+* @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 compose = require( './index' );
+
+const a = ( x: number ): number => {
+	return x * 2;
+};
+
+const b = ( x: number ): number => {
+	return x + 3;
+};
+
+const c = ( x: number ): number => {
+	return x / 5;
+};
+
+// TESTS //
+
+// The function returns a function...
+{
+	compose( a, b, c ); // $ExpectType Function
+	compose( a, b ); // $ExpectType Function
+}
+
+// The compiler throws an error if the function is provided arguments other than functions...
+{
+	compose( a, b, 'abc' ); // $ExpectError
+	compose( a, b, 5 ); // $ExpectError
+	compose( a, b, [] ); // $ExpectError
+	compose( a, b, {} ); // $ExpectError
+	compose( a, b, true ); // $ExpectError
+	compose( a, b, false ); // $ExpectError
+
+	compose( a, 'abc', c ); // $ExpectError
+	compose( a, 5, c ); // $ExpectError
+	compose( a, [], c ); // $ExpectError
+	compose( a, {}, c ); // $ExpectError
+	compose( a, true, c ); // $ExpectError
+	compose( a, false, c ); // $ExpectError
+
+	compose( 'abc', b, c ); // $ExpectError
+	compose( 5, b, c ); // $ExpectError
+	compose( [], b, c ); // $ExpectError
+	compose( {}, b, c ); // $ExpectError
+	compose( true, b, c ); // $ExpectError
+	compose( false, b, c ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/compose/package.json b/lib/node_modules/@stdlib/utils/compose/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
