Docs: Various fixes in "Mid run cancellation" section #235
Conversation
This file contains 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
`signal` does not need to be checked, since `fetch` will reject.
✅ Deploy Preview for sheepdog ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
brunnerh
commented
Nov 23, 2024
Comment on lines
276
to
278
| const response = await fetch('/api/very-long-list', { signal }); | ||
| // this line will never be executed if the task is canceled before fetch ends | ||
| list = await response.json(); |
There was a problem hiding this comment.
This is already the case because of the signal.
Should this be adjusted?
brunnerh
commented
Nov 23, 2024
| a way to stop executing and return something to the caller and the caller has a way to communicate | ||
| something back. | ||
|
|
||
| `@sheepdog/svelte` has been built to be able to accept an async generator function and, most | ||
| importantly, has been built to make the generator function work basically like a normal async | ||
| function if you change `await` with `yield`. Let's take a look | ||
| function if you replace `await` with `yield`. Let's take a look | ||
|
|
||
| <Tabs> |
There was a problem hiding this comment.
The following tabs section also has this simple example where the signal already does all the work.
paoloricciuti
approved these changes
Nov 28, 2024
commit: |
Merged
paoloricciuti
added
documentation
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.
An
AbortSignaldoes not need to be checked after thefetchusing it, sincefetchwill reject onabort.I initially thought that removing the check would be enough, but the following sections build on this example which makes the generator approach redundant for such a simple case. Will add further comments marking the sections.
Lowercase after colons is a more British English style. I changed it here to what apparently is more commonly seen in American English (did not know that there was this distinction beforehand). This should probably either be applied elsewhere for consistency or be reverted again.
(If this document was auto-formatted, that would probably need to be re-applied.)