Skip to content
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

Docs edits #53

Merged
merged 3 commits into from
Jan 12, 2025
Merged

Docs edits #53

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b1ce90
docs edits
shtaif Jan 12, 2025
5151c74
Merge branch 'master' into docs-edit
shtaif Jan 12, 2025
8c7b56f
Merge branch 'master' into docs-edit
shtaif Jan 12, 2025
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 src/useAsyncIter/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export { useAsyncIter, type IterationResult };
* );
* }
* ```
*
* ---
*
* Given an async iterable `input`, this hook will iterate it value-by-value and update (re-render) the
* host component upon each yielded value, along with any possible completion or error it may run into.
Expand All @@ -58,6 +60,8 @@ export { useAsyncIter, type IterationResult };
* {@link IterationResult `IterationResult`}).
* In case `input` is given a plain value, it will be delivered as-is within the returned
* result object's `value` property.
*
* ---
*
* @template TVal The type of values yielded by the passed iterable or type of plain value if otherwise passed.
* @template TInitVal The type of the initial value, defaults to `undefined`.
Expand Down
Loading