Skip to content

Commit 31bf95f

Browse files
authored
docs: document short-circuit early-return
PR-URL: #12384 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent b5ae032 commit 31bf95f

4 files changed

Lines changed: 16 additions & 0 deletions

File tree

lib/node_modules/@stdlib/iter/any/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ var bool = iterAny( array2iterator( [] ) );
7070

7171
<section class="notes">
7272

73+
## Notes
74+
75+
- The function immediately returns upon encountering a truthy value.
76+
7377
</section>
7478

7579
<!-- /.notes -->

lib/node_modules/@stdlib/iter/every/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ var bool = iterEvery( array2iterator( [] ) );
7070

7171
<section class="notes">
7272

73+
## Notes
74+
75+
- The function immediately returns upon encountering a falsy value.
76+
7377
</section>
7478

7579
<!-- /.notes -->

lib/node_modules/@stdlib/iter/none/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ var bool = iterNone( array2iterator( [] ) );
7070

7171
<section class="notes">
7272

73+
## Notes
74+
75+
- The function immediately returns upon encountering a truthy value.
76+
7377
</section>
7478

7579
<!-- /.notes -->

lib/node_modules/@stdlib/iter/some/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ var bool = iterSome( array2iterator( [] ), 1 );
7070

7171
<section class="notes">
7272

73+
## Notes
74+
75+
- The function immediately returns upon finding `n` truthy values.
76+
7377
</section>
7478

7579
<!-- /.notes -->

0 commit comments

Comments
 (0)