API: WebWorkers documentation status

This page tracks ongoing documentation work in the MDN Web Workers section. Feel free to contribute!

Note: This list is not yet complete as proper tagging of API pages is still to be done.

Summary

Pages Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages Missing pages Dev-doc-needed bugs Documentation requests
36 1 (3%) 0 (0%) 0 (0%) 5 (14%) 23 (64%) 0 (0%) 5 (14%) 4 (12%)

See also localization status of this section.

Needs* tags

Found 1 pages. Learn more about how to deal with meta-tags.

Technical reviews

Found 5 pages. Learn more about how to do a technical review.

Outdated pages

Found 23 pages. These pages haven't been updated in over a year. Outdated pages can have problems with both content and format. Look at these pages and consider: Is this page talking about the Web of today? Does it look consistent with newer pages in this topic area? If not, make any needed changes.

Dev-doc-needed bugs

Found 5 bugs. Learn more about how to resolve a dev-doc-needed bug.

Bug Summary Release
790919 Don't dispatch close event, and remove onclose mozilla51
842818 [WebCryptoAPI] Enable Crypto in workers mozilla48
931243 XMLHttpRequest should be disabled on ServiceWorkers mozilla44
504553 WebSocket in Workers mozilla35
924089 Enable SharedWorker by default mozilla29

Browse as bug list.

Documentation requests

Found 4 bugs. Documentation request bugs can contain various kinds work related to MDN pages. Read through the bug and ask questions in the bug if in doubt.

Bug Summary
1045721 "Using web workers" needs code improvements
1249684 Incorrect HTML anchor for Web Push API
1258149 Several links in the events section of Service workers result in 404
1264889 pushManager.subscribe() does not resolve with subscriptionId

Browse as bug list.

Localizations

Please help us to localize this documentation into different languages. Read more about how to translate.

Language Pages Translated Translations up to date
af 36 1 (2%) 0 (0%)
bn-BD 36 1 (2%) 0 (0%)
de 36 0 (0%) 0 (0%)
es 36 3 (8%) 1 (33%)
fa 36 0 (0%) 0 (0%)
fr 36 21 (58%) 11 (52%)
it 36 0 (0%) 0 (0%)
ja 36 7 (19%) 5 (71%)
ko 36 4 (11%) 2 (50%)
pl 36 0 (0%) 0 (0%)
pt-BR 36 4 (11%) 2 (50%)
pt-PT 36 0 (0%) 0 (0%)
ro 36 0 (0%) 0 (0%)
ru 36 3 (8%) 2 (66%)
zh-CN 36 5 (13%) 3 (60%)
zh-TW 36 1 (2%) 1 (100%)

Goals

  • Complete references for all Worker interfaces, including all interfaces (and their properties and methods).
    • Update all existing worker documents, including:
      • ...
    • Write interface landing pages and reference pages for all undocumented worker interfaces and their properties and methods.
  • Thorough guide to each type of Worker, covering:
    • Use cases
    • Functional differences
    • Proper usage
  • Guide to choosing the right type of worker for your needs
  • Solid examples that provide adequate coverage for all Worker classes
  • Update all API documentation to indicate whether or not they can be used from workers
    • This means figuring out a standard, easy to spot and understand, method for providing this information.
    • Could we use a badge that appears somewhere near the top of the page?
    • Or does it just go in the info block at the top of the page?
  • Similarly, find places elsewhere on MDN where proposing the use of a worker makes sense and link to appropriate docs.
  • We have a few scattered half-baked tutorials and guides for workers that need to be updated, merged, and/or replaced, including

Notes

Tagging standard

  • Grouping tag is: "Web Workers"

Other tasks to do

  • TBD

Tutorial to-do list

  • TBD

Notes for translators

Any notes here? Where do we expect updates, so that localizers don't translate and update too often?

Specifications

The interfaces defined in the following specifications are tracked by this status page:

Specification Status Comment
Web Workers Editor's Draft  

Document Tags and Contributors

 Contributors to this page: fscholz
 Last updated by: fscholz,