Use overloads to describe predicate function

kgryte · kgryte · commit b5300172e23c · 2019-02-02T01:35:11.000-08:00
diff --git a/lib/node_modules/@stdlib/iter/reject/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/reject/docs/types/index.d.ts
@@ -25,14 +25,38 @@ import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
 // Define a union type representing both iterable and non-iterable iterators:
 type Iterator = Iter | IterableIterator;
 
+/**
+* Checks whether an iterated value passes a test.
+*
+* @returns boolean indicating whether an iterated value passes a test
+*/
+type Nullary = () => boolean;
+
+/**
+* Checks whether an iterated value passes a test.
+*
+* @param value - iterated value
+* @returns boolean indicating whether an iterated value passes a test
+*/
+type Unary = ( value: any ) => boolean;
+
+/**
+* Checks whether an iterated value passes a test.
+*
+* @param value - iterated value
+* @param i - iteration index
+* @returns boolean indicating whether an iterated value passes a test
+*/
+type Binary = ( value: any, i: number ) => boolean;
+
 /**
 * Checks whether an iterated value passes a test.
 *
 * @param value - iterated value
 * @param i - iteration index
 * @returns boolean indicating whether an iterated value passes a test
 */
-type Predicate = ( value?: any, i?: number ) => boolean;
+type Predicate = Nullary | Unary | Binary;
 
 /**
 * Returns an iterator which rejects a provided iterator's values according to a predicate function.
diff --git a/lib/node_modules/@stdlib/iter/reject/docs/types/test.ts b/lib/node_modules/@stdlib/iter/reject/docs/types/test.ts
@@ -44,19 +44,22 @@ function iterator() {
 /**
 * Predicate function.
 *
+* @param _v - iterated value
+* @param i - iteration index
 * @returns a boolean
 */
-function predicate1() {
-	return false;
+function predicate1( _v: any, i: number ): boolean { // tslint:disable-line:variable-name
+	return ( i > 5 );
 }
 
 /**
 * Predicate function.
 *
+* @param v - iterated value
 * @returns a boolean
 */
-function predicate2() {
-	return true;
+function predicate2( v: any ): boolean {
+	return ( v !== v );
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -44,19 +44,22 @@ function iterator() {`
`44`	`44`	`/**`
`45`	`45`	`* Predicate function.`
`46`	`46`	`*`
	`47`	`+* @param _v - iterated value`
	`48`	`+* @param i - iteration index`
`47`	`49`	`* @returns a boolean`
`48`	`50`	`*/`
`49`		`-function predicate1() {`
`50`		`- return false;`
	`51`	`+function predicate1( _v: any, i: number ): boolean { // tslint:disable-line:variable-name`
	`52`	`+ return ( i > 5 );`
`51`	`53`	`}`
`52`	`54`
`53`	`55`	`/**`
`54`	`56`	`* Predicate function.`
`55`	`57`	`*`
	`58`	`+* @param v - iterated value`
`56`	`59`	`* @returns a boolean`
`57`	`60`	`*/`
`58`		`-function predicate2() {`
`59`		`- return true;`
	`61`	`+function predicate2( v: any ): boolean {`
	`62`	`+ return ( v !== v );`
`60`	`63`	`}`
`61`	`64`
`62`	`65`