Skip to content

docs: document short-circuit early-return #12384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 4 commits into from
May 31, 2026
Merged

docs: document short-circuit early-return #12384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3ef3f5
docs: document early-return behavior in `@stdlib/iter/any`
claude May 31, 2026
5592404
docs: document early-return behavior in `@stdlib/iter/every`
claude May 31, 2026
b8e2042
docs: document early-return behavior in `@stdlib/iter/none`
claude May 31, 2026
85aa41d
docs: document early-return behavior in `@stdlib/iter/some`
claude May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/iter/any/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ var bool = iterAny( array2iterator( [] ) );

<section class="notes">

## Notes

- The function immediately returns upon encountering a truthy value.

</section>

<!-- /.notes -->
Expand Down
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/iter/every/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ var bool = iterEvery( array2iterator( [] ) );

<section class="notes">

## Notes

- The function immediately returns upon encountering a falsy value.

</section>

<!-- /.notes -->
Expand Down
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/iter/none/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ var bool = iterNone( array2iterator( [] ) );

<section class="notes">

## Notes

- The function immediately returns upon encountering a truthy value.

</section>

<!-- /.notes -->
Expand Down
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/iter/some/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ var bool = iterSome( array2iterator( [] ), 1 );

<section class="notes">

## Notes

- The function immediately returns upon finding `n` truthy values.

</section>

<!-- /.notes -->
Expand Down