missing docs: web worker
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
Start with the WebWorker section in README and review the existing worker examples and caveats. Document the messages the worker accepts and returns, its limitations, and whether files from node_modules/sql.js/dist can be used; also cover the missing @types/sql.js worker definitions. Done means users have a complete WebWorker usage explanation on the website or GitHub wiki.
索引モデルが issue の本文から書いたものです。
説明
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.
It gives a couple examples and caveats, but I need a lot more information to use the feature. I need a list of messages I can pass, what the worker will pass back, and a description of what the limitations are. There's no page on the website or GitHub wiki about this.
Other issues:
- The docs say to get the file from the releases page, but I'd rather get them from
node_modules/sql.js/distso they get version updates. But someone in this issue said that won't work. This is something that should be covered in a full explanation of how to use web workers. @types/sql.jsis missing types for the web worker API.- Existing issue caused by these missing docs: https://github.com/sql-js/sql.js/issues/490
Because of these missing docs, for my app I'm going to write my own custom web worker using the normal SQL.js API.
I'll also highlight the proposal to remove the whole web worker API, which would be a way to avoid this whole issue (though you'd still want the docs to have some hints about how/why to write a custom web worker): https://github.com/sql-js/sql.js/issues/377
- 主要言語
- JavaScript
- スター
- 13.7k
- フォーク
- 1.1k
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
sql-js/sql.js のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
似ている issue
-
Edit: CW+ オープンchannels:edit check:passed
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
idean3885/claude-ops-agent#521 ·
-
forespørsel 🥰 ikoner 🖼 nytt ✨
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
avniproject/avni-client#2135 ·
-
automated broken-link
難易度 1/5 1時間未満 初心者へのやさしさ 85/100