Add TypeScript definition file

kgryte · kgryte · commit 62c2c7a01b96 · 2019-01-14T18:26:19.000-08:00
diff --git a/lib/node_modules/@stdlib/iter/any/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/any/docs/types/index.d.ts
@@ -0,0 +1,65 @@
+/**
+* @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
+
+interface Iterator {
+	/**
+	* Returns an iterator protocol-compliant object containing the next iterated value (if one exists) and a boolean flag indicating whether the iterator is finished.
+	*
+	* @returns iterator protocol-compliant object
+	*/
+	next(): IteratorResult;
+}
+
+interface IteratorResult {
+	/**
+	* Iterated value (if one exists).
+	*/
+	value?: any;
+
+	/**
+	* Boolean flag indicating whether the iterator is finished.
+	*/
+	done: boolean;
+}
+
+
+// MAIN //
+
+/**
+* Tests whether at least one iterated value is truthy.
+*
+* @param iterator - input iterator
+* @returns boolean indicating whether at least one iterated value is truthy
+*
+* @example
+*
+* var array2iterator = require( '@stdlib/array/to-iterator' );
+*
+* var it = array2iterator( [ 0, 0, 0, 0, 1 ] );
+*
+* var bool = iterAny( it );
+* // returns true
+*/
+declare function iterAny( iterator: Iterator ): boolean;
+
+
+// EXPORTS //
+
+export = iterAny;
diff --git a/lib/node_modules/@stdlib/iter/any/docs/types/test.ts b/lib/node_modules/@stdlib/iter/any/docs/types/test.ts
@@ -0,0 +1,54 @@
+/**
+* @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 iterAny = require( './index' );
+
+
+// FUNCTIONS //
+
+/**
+* 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 //
+
+iterAny( iterator() ); // $ExpectType boolean
+iterAny( null ); // $ExpectError
+iterAny( [] ); // $ExpectError
+iterAny( {} ); // $ExpectError
+iterAny(); // $ExpectError
diff --git a/lib/node_modules/@stdlib/iter/any/package.json b/lib/node_modules/@stdlib/iter/any/package.json
@@ -22,6 +22,7 @@
     "test": "./test"
   },
   "scripts": {},
+  "types": "./docs/types",
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
     "type": "git",
