Add the WebWorker API docs

Open
#626 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the README passage about the WebWorker API and inspect the project's existing WebWorker API entry points or documentation. Document what the API does, explain its limitations compared with the main application thread, and provide a link or location for the API docs.

Written by the indexing model from the issue text.

Description

The Readme says

If you don't want to run CPU-intensive SQL queries in your main application thread, you can use the more limited WebWorker API.

What exactly it does mean? What limitations the WebWorker API have? And where I can find the WebWorker API docs?

Dominant language
JavaScript
Stars
13.7k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

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.

More from sql-js/sql.js

All issues in sql-js/sql.js

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.