Skip to content

Commit 4f34af5

Browse files
committed
chore: remove extra spaces and add missing TSDoc comments
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 930998f commit 4f34af5

File tree

3 files changed

+66
-2
lines changed

3 files changed

+66
-2
lines changed

lib/node_modules/@stdlib/iter/cuany-by/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ declare function iterCuAnyBy<T, U>( iterator: Iterator<T>, predicate: Predicate<
9595

9696
// EXPORTS //
9797

98-
export = iterCuAnyBy ;
98+
export = iterCuAnyBy;

lib/node_modules/@stdlib/iter/cuevery-by/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ declare function iterCuEveryBy<T, U>( iterator: Iterator<T>, predicate: Predicat
9595

9696
// EXPORTS //
9797

98-
export = iterCuEveryBy ;
98+
export = iterCuEveryBy;

lib/node_modules/@stdlib/iter/docs/types/index.d.ts

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,38 @@ interface Namespace {
278278
*/
279279
iterCuAny: typeof iterCuAny;
280280

281+
/**
282+
* Returns an iterator which cumulatively tests whether at least one iterated value passes a test implemented by a predicate function.
283+
*
284+
* @param iterator - source iterator
285+
* @param predicate - predicate function
286+
* @param thisArg - execution context
287+
* @returns iterator
288+
*
289+
* @example
290+
* var array2iterator = require( '@stdlib/array/to-iterator' );
291+
*
292+
* function isPositive( v ) {
293+
* return ( v > 0 );
294+
* }
295+
*
296+
* var it = ns.iterCuAnyBy( array2iterator( [ 0, 0, 0, 1, 0 ] ), isPositive );
297+
*
298+
* var v = it.next().value;
299+
* // returns false
300+
*
301+
* v = it.next().value;
302+
* // returns false
303+
*
304+
* v = it.next().value;
305+
* // returns false
306+
*
307+
* v = it.next().value;
308+
* // returns true
309+
*
310+
* v = it.next().value;
311+
* // returns true
312+
*/
281313
iterCuAnyBy: typeof iterCuAnyBy;
282314

283315
/**
@@ -313,6 +345,38 @@ interface Namespace {
313345
*/
314346
iterCuEvery: typeof iterCuEvery;
315347

348+
/**
349+
* Returns an iterator which cumulatively tests whether every iterated value passes a test implemented by a predicate function.
350+
*
351+
* @param iterator - source iterator
352+
* @param predicate - predicate function
353+
* @param thisArg - execution context
354+
* @returns iterator
355+
*
356+
* @example
357+
* var array2iterator = require( '@stdlib/array/to-iterator' );
358+
*
359+
* function isPositive( v ) {
360+
* return ( v > 0 );
361+
* }
362+
*
363+
* var it = ns.iterCuEveryBy( array2iterator( [ 1, 1, 1, 0, 1 ] ), isPositive );
364+
*
365+
* var v = it.next().value;
366+
* // returns true
367+
*
368+
* v = it.next().value;
369+
* // returns true
370+
*
371+
* v = it.next().value;
372+
* // returns true
373+
*
374+
* v = it.next().value;
375+
* // returns false
376+
*
377+
* v = it.next().value;
378+
* // returns false
379+
*/
316380
iterCuEveryBy: typeof iterCuEveryBy;
317381

318382
/**

0 commit comments

Comments
 (0)