Add Typescript definition

Planeshifter · Planeshifter · commit c9fea253fafb · 2019-04-12T20:39:51.000-04:00
diff --git a/lib/node_modules/@stdlib/stats/iter/cumax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/iter/cumax/docs/types/index.d.ts
@@ -0,0 +1,60 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator } from '@stdlib/types/iter';
+
+/**
+* Returns an iterator which iteratively computes a cumulative maximum value.
+*
+* ## Notes
+*
+* -   If an environment supports Symbol.iterator, the returned iterator is iterable.
+*
+* @param iterator - input iterator
+* @returns iterator
+*
+* @example
+* var runif = require( '@stdlib/random/iter/uniform' );
+*
+* var rand = runif( -10.0, 10.0, {
+*     'iter': 100
+* });
+*
+* var it = itercumax( rand );
+*
+* var v = it.next().value;
+* // returns <number>
+*
+* v = it.next().value;
+* // returns <number>
+*
+* v = it.next().value;
+* // returns <number>
+*
+* // ...
+*/
+declare function itercumax( iterator: Iterator ): Iterator;
+
+
+// EXPORTS //
+
+export = itercumax;
diff --git a/lib/node_modules/@stdlib/stats/iter/cumax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/iter/cumax/docs/types/test.ts
@@ -0,0 +1,68 @@
+/*
+* @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 itercumax = require( './index' );
+
+/**
+* Returns an iterator protocol-compliant object.
+*
+* @returns iterator protocol-compliant object
+*/
+function iterator() {
+	return {
+		'next': next
+	};
+
+	/**
+	* Implements the iterator protocol `next` method.
+	*
+	* @returns iterator protocol-compliant object
+	*/
+	function next() {
+		return {
+			'value': true,
+			'done': false
+		};
+	}
+}
+
+
+// TESTS //
+
+// The function returns an iterator...
+{
+	itercumax( iterator() ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a value other than an iterator protocol-compliant object...
+{
+	itercumax( '5' ); // $ExpectError
+	itercumax( 5 ); // $ExpectError
+	itercumax( true ); // $ExpectError
+	itercumax( false ); // $ExpectError
+	itercumax( null ); // $ExpectError
+	itercumax( undefined ); // $ExpectError
+	itercumax( [] ); // $ExpectError
+	itercumax( {} ); // $ExpectError
+	itercumax( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	itercumax(); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/stats/iter/cumax/package.json b/lib/node_modules/@stdlib/stats/iter/cumax/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
