Improve the kdoc on the newly-public collectToSink. #1262
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rjrjr
approved these changes
Feb 4, 2025
| * to the [actionSink]. This operator propagates back pressure from the workflow runtime, so if there | ||
| * is a lot of contention on the workflow runtime the flow will be suspended while the action is | ||
| * queued. | ||
| * to the [actionSink]. This may be used as an alternative to a [asWorker] for certain [Flow]s. |
There was a problem hiding this comment.
Suggested change
| * to the [actionSink]. This may be used as an alternative to a [asWorker] for certain [Flow]s. | |
| * to the [actionSink]. This may be used as a lighter weight alternative to | |
| * [asWorker] for certain [Flow]s. |
| * > **Warning:** Be careful using this from `runningSideEffect` when the source [Flow] comes from | ||
| * > state or props. The side effect will capture those values when it first runs, and if the instance | ||
| * > of the flow changes in a future render pass, the side effect will still be collecting the stale | ||
| * > [Flow]. In this case |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.