mdn / mdn/browser-compat-data

Tag everything with worker support?

Open
#7,849 18 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

data:api idle
Dominant language
JSON
Stars
5.8k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
186

Description

Worker support of APIs is quite a challenge to track and maintain docs for - it can vary across an API and be spotty across browsers. It also isn't necessarily obvious to a user how they go about using some APIs.

I think it might make sense to "standardise" this in BCD and roll it out more or less for every single Web API.

  • There are four types of workers - dedicated, shared, service, chrome. I don't know if we'd need to indicate these separately or not.
  • It is useful to note the API used to access the feature in both main thread (often via window or window.navigator) and the web service (usually some context)

There are a few good examples where this has been done in an adhoc way:

FYI @chrisdavidmills @Elchi3 @ddbeck Would appreciate your thinking on this. To me this is a similar problem to documenting secure contexts.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the existing worker-support entries in FileReaderSync.json and CacheStorage.json with the linked MDN Web Workers documentation. Clarify how dedicated, shared, service, and chrome workers and their access contexts should be represented, then determine which Web API data files would need the standardized treatment. Done means the representation and rollout scope are agreed and consistently applied.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.