Add Typescript definition

Planeshifter · Planeshifter · commit 3facf3ad41c2 · 2019-07-30T18:18:37.000-06:00
diff --git a/lib/node_modules/@stdlib/utils/memoize/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/memoize/docs/types/index.d.ts
@@ -0,0 +1,58 @@
+/*
+* @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
+
+/**
+* Returns a memoized function.
+*
+* ## Notes
+*
+* -   The function does not set the `length` property of the returned function. Accordingly, the returned function `length` is always zero.
+* -   The evaluation context is always `null`.
+* -   The function serializes provided arguments as a string and stores results using the string as an identifier. To use a custom hash function, provide a hash function argument.
+*
+* @param fcn - function to memoize
+* @param hashFunction - function to map a set of arguments to a single value identifying that set
+* @returns memoized function
+*
+* @example
+* function factorial( n ) {
+*     var prod;
+*     var i;
+*     prod = 1;
+*     for ( i = n; i > 1; i-- ) {
+*         prod *= i;
+*     }
+*     return prod;
+* }
+*
+* var memoized = memoize( factorial );
+*
+* var v = memoized( 5 );
+* // returns 120
+*
+* v = memoized( 5 );
+* // returns 120
+*/
+declare function memoize( fcn: Function, hashFunction?: Function ): Function;
+
+
+// EXPORTS //
+
+export = memoize;
diff --git a/lib/node_modules/@stdlib/utils/memoize/docs/types/test.ts b/lib/node_modules/@stdlib/utils/memoize/docs/types/test.ts
@@ -0,0 +1,77 @@
+/*
+* @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 memoize = require( './index' );
+
+/**
+* Evaluates the factorial of `n`.
+*
+* @param n - input value
+* @returns factorial
+*/
+function factorial( n: number ) {
+	let prod = 1;
+	for ( let i = n; i > 1; i -= 1 ) {
+		prod *= i;
+	}
+	return prod;
+}
+
+/**
+* Hash function.
+*
+* @param arg - argument
+* @returns hashed value
+*/
+function hashFunction( arg: number ): string {
+	return arg.toString();
+}
+
+// TESTS //
+
+// The function returns a function...
+{
+	memoize( factorial ); // $ExpectType Function
+	memoize( factorial, hashFunction ); // $ExpectType Function
+}
+
+// The compiler throws an error if the function is provided a first argument other than a function...
+{
+	memoize( 'abc' ); // $ExpectError
+	memoize( 5 ); // $ExpectError
+	memoize( [] ); // $ExpectError
+	memoize( {} ); // $ExpectError
+	memoize( true ); // $ExpectError
+	memoize( false ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument other than a function...
+{
+	memoize( factorial, 'abc' ); // $ExpectError
+	memoize( factorial, 5 ); // $ExpectError
+	memoize( factorial, [] ); // $ExpectError
+	memoize( factorial, {} ); // $ExpectError
+	memoize( factorial, true ); // $ExpectError
+	memoize( factorial, false ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	memoize(); // $ExpectError
+	memoize( factorial, hashFunction, false ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/memoize/package.json b/lib/node_modules/@stdlib/utils/memoize/package.json
@@ -20,6 +20,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
