You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/iter/docs/types/index.d.ts
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -476,15 +476,16 @@ interface Namespace {
476
476
* v = it.next().value;
477
477
* // returns true
478
478
*
479
-
* // ..
479
+
* var bool = it.next().done;
480
+
* // returns true
480
481
*/
481
482
iterCuSome: typeofiterCuSome;
482
483
483
484
/**
484
485
* Returns an iterator which cumulatively tests whether at least `n` iterated values pass a test implemented by a predicate function.
485
486
*
486
487
* @param iterator - source iterator
487
-
* @param n - minimum number of truthy elements
488
+
* @param n - minimum number of successful values
488
489
* @param predicate - predicate function
489
490
* @param thisArg - execution context
490
491
* @returns iterator
@@ -525,7 +526,7 @@ interface Namespace {
525
526
* @param start - starting date as either a `Date` object, JavaScript timestamp, or a date string (inclusive)
526
527
* @param stop - stopping date as either a `Date` object, JavaScript timestamp, or a date string (inclusive)
527
528
* @param options - function options
528
-
* @param options.round - specifies how sub-millisecond times should be rounded: 'floor', 'ceil', or 'round' (default: 'floor')
529
+
* @param options.round - specifies how sub-millisecond times should be rounded: 'floor', 'ceil', or 'round' (default: 'floor')
529
530
* @throws a numeric `start` argument must be a nonnegative integer
530
531
* @throws a numeric `stop` argument must be a nonnegative integer
531
532
* @throws unable to parse date string
@@ -661,15 +662,15 @@ interface Namespace {
661
662
* // returns 2
662
663
*
663
664
* r = it.next().value;
664
-
* // undefined
665
+
* // returns undefined
665
666
*
666
667
* // ...
667
668
*/
668
669
iterDoUntilEach: typeofiterDoUntilEach;
669
670
670
671
/**
671
672
* Returns an iterator which invokes a function for each iterated value **before** returning the iterated value until either a predicate function returns `false` or the iterator has iterated over all values.
672
-
* The condition is evaluated *after* executing the provided function; thus, fcn` *always* executes at least once.
673
+
* The condition is evaluated *after* executing the provided function; thus, `fcn` *always* executes at least once.
673
674
*
674
675
* ## Notes
675
676
*
@@ -780,7 +781,7 @@ interface Namespace {
780
781
*
781
782
* @param iterator - input iterator
782
783
* @param value - static (fill) value
783
-
* @param begin - start iteration index (inclusive)
784
+
* @param begin - start iteration index (inclusive; default: 0)
784
785
* @param end - end iteration index (non-inclusive)
785
786
* @returns iterator
786
787
*
@@ -1537,7 +1538,7 @@ interface Namespace {
1537
1538
iterReplicate: typeofiterReplicate;
1538
1539
1539
1540
/**
1540
-
* Returns an iterator which invokes a function for each iterated value.
1541
+
* Returns an iterator which replicates each iterated value according to a provided function.
1541
1542
*
1542
1543
* ## Notes
1543
1544
*
@@ -1724,7 +1725,7 @@ interface Namespace {
1724
1725
* @param iterator - input iterator
1725
1726
* @param stride - stride
1726
1727
* @param offset - offset
1727
-
* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset`
1728
+
* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset` (default: false)
0 commit comments