Doc suggestion: Using `debug` in WebWorkers / SharedWorkers

Open
#916 1 comment 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Read the documentation sections titled “Set dynamically” and “Browser Support” to confirm how the dynamic approach applies in WebWorkers and SharedWorkers. Add a brief note explaining that localStorage is unavailable there and point readers toward the dynamic approach; done means the browser support guidance is clearer for worker users.

Written by the indexing model from the issue text.

Description

Just a quick note that localStorage isn't available in web workers. The dynamic approach described under "Set dynamically" works fine in this environment but it might be worth adding a sentence or two in the "Browser Support" section of the docs to hint people in the right direction.

Thanks for a helpful library!

Dominant language
JavaScript
Stars
11.5k
Forks
992
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from debug-js/debug

All issues in debug-js/debug

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.