Add Typescript documentation for function parameters

Planeshifter · Planeshifter · commit 1cefe20145e3 · 2019-09-07T16:12:53.000-04:00
diff --git a/lib/node_modules/@stdlib/utils/every-by-right/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/every-by-right/docs/types/index.d.ts
@@ -22,6 +22,50 @@
 
 import { Collection } from '@stdlib/types/object';
 
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Nullary = () => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Unary = ( value: any ) => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Binary = ( value: any, index: number ) => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Tertiary = ( value: any, index: number, collection: Collection ) => boolean; // tslint-disable-line max-line-length
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Predicate = Nullary | Unary | Binary | Tertiary;
+
 /**
 * Tests whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left.
 *
@@ -52,7 +96,7 @@ import { Collection } from '@stdlib/types/object';
 * var bool = everyByRight( arr, isPositive );
 * // returns true
 */
-declare function everyByRight( collection: Collection, predicate: Function, thisArg?: any ): boolean; // tslint-disable-line max-line-length
+declare function everyByRight( collection: Collection, predicate: Predicate, thisArg?: any ): boolean; // tslint-disable-line max-line-length
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/utils/every-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/every-by/docs/types/index.d.ts
@@ -22,6 +22,50 @@
 
 import { Collection } from '@stdlib/types/object';
 
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Nullary = () => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Unary = ( value: any ) => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Binary = ( value: any, index: number ) => boolean;
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Tertiary = ( value: any, index: number, collection: Collection ) => boolean; // tslint-disable-line max-line-length
+
+/**
+* Checks whether an element in a collection passes a test.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+* @returns boolean indicating whether an element in a collection passes a test
+*/
+type Predicate = Nullary | Unary | Binary | Tertiary;
+
 /**
 * Tests whether all elements in a collection pass a test implemented by a predicate function.
 *
@@ -52,7 +96,7 @@ import { Collection } from '@stdlib/types/object';
 * var bool = everyBy( arr, isPositive );
 * // returns true
 */
-declare function everyBy( collection: Collection, predicate: Function, thisArg?: any ): boolean; // tslint-disable-line max-line-length
+declare function everyBy( collection: Collection, predicate: Predicate, thisArg?: any ): boolean; // tslint-disable-line max-line-length
 
 
 // EXPORTS //
