Add scheduler.yield() #35960
Add scheduler.yield() #35960
Conversation
github-actions
bot
added
Content:WebAPI
|
Preview URLs
External URLs (1)URL:
(comment last updated: 2024-09-25 15:57:35) |
|
|
||
| By default, `scheduler.yield()` is run with a [`'user-visible'`](/en-US/docs/Web/API/Prioritized_Task_Scheduling_API#user-visible) priority. However, the continuation from a `scheduler.yield()` has a slightly different behavior than `scheduler.postTask()` tasks of the same `priority`. | ||
|
|
||
| `scheduler.yield()` enqueues its task at the front of a priority level's queue, while `scheduler.postTask()` tasks go at the end (in the spec, this is defined by a task queue's [effective priority](https://wicg.github.io/scheduling-apis/#scheduler-task-queue-effective-priority)). This means that with the same priority, the `scheduler.yield()` continuation will come first, allowing additional flexibility in how tasks can be scheduled. |
There was a problem hiding this comment.
Whhhattt! This is news to me!
Even more reason to use yield over postTask then!
|
|
||
| ### Basic usage | ||
|
|
||
| Long tasks can be broken up by awaiting `scheduler.yield()`. The function returns a promise, yielding the {{Glossary('main thread')}} to allow the browser to execute other pending work—like responding to user input—if needed. |
There was a problem hiding this comment.
I feel like this glossary definition should be linked much earlier in the guide.
There was a problem hiding this comment.
Haha good call. I think it might have migrated down as the article evolved :) Moved to first instance of "main thread".
Co-authored-by: Jeremy Wagner <[email protected]>
|
|
||
| ### Basic usage | ||
|
|
||
| Long tasks can be broken up by awaiting `scheduler.yield()`. The function returns a promise, yielding the {{Glossary('main thread')}} to allow the browser to execute other pending work—like responding to user input—if needed. |
There was a problem hiding this comment.
Haha good call. I think it might have migrated down as the article evolved :) Moved to first instance of "main thread".
|
|
||
| ### Inheriting task priorities | ||
|
|
||
| A `scheduler.yield()` within a `scheduler.postTask()` task will inherit the task's priority. For example, work after a `scheduler.yield()` within a [`'background'`](/en-US/docs/Web/API/Prioritized_Task_Scheduling_API#user-blocking) low-priority task will also be scheduled as `'background'` by default (but, again, inserted in the boosted `'background'` priority queue, so running before any `'background'` `postTask` tasks). |
There was a problem hiding this comment.
I'm not familiar with the MDN style guide, but I noticed that you have single quotes around the string 'background' here but then use double quotes in the code snippet.
There was a problem hiding this comment.
Damn you prettier. Switching to double quotes for everything 🤮
|
@chrisdavidmills I think this is ready for you |
There was a problem hiding this comment.
@brendankenny nice work! I've reviewed this pretty thoroughly and left quite a few comments, but most of them are fairly minor language suggestions/nitpicks.
Co-authored-by: Chris Mills <[email protected]> Co-authored-by: Joshua Chen <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Co-authored-by: Chris Mills <[email protected]>
|
Thanks for the great review @chrisdavidmills! I believe everything should be addressed. |
There was a problem hiding this comment.
Nice work @brendankenny. Let's get this published, and we can iterate further if needed.
* Add scheduler.yield() * Apply suggestions from code review Co-authored-by: Jeremy Wagner <[email protected]> * review feedback * clarify priority queues and requestIdleCallback * fix one more reference to front of the queue behavior * more review feedback * Apply suggestions from code review Co-authored-by: Chris Mills <[email protected]> Co-authored-by: Joshua Chen <[email protected]> * Apply suggestions from code review Co-authored-by: Chris Mills <[email protected]> * heading changes * syntax consistency in headings --------- Co-authored-by: Jeremy Wagner <[email protected]> Co-authored-by: Chris Mills <[email protected]> Co-authored-by: Joshua Chen <[email protected]>
* Add scheduler.yield() * Apply suggestions from code review Co-authored-by: Jeremy Wagner <[email protected]> * review feedback * clarify priority queues and requestIdleCallback * fix one more reference to front of the queue behavior * more review feedback * Apply suggestions from code review Co-authored-by: Chris Mills <[email protected]> Co-authored-by: Joshua Chen <[email protected]> * Apply suggestions from code review Co-authored-by: Chris Mills <[email protected]> * heading changes * syntax consistency in headings --------- Co-authored-by: Jeremy Wagner <[email protected]> Co-authored-by: Chris Mills <[email protected]> Co-authored-by: Joshua Chen <[email protected]>
Description
Chrome 129 adds
yieldmethod to the Scheduler interface. This PR adds reference documentation for the new method.Additional details