Request: Improve documentation for `openWhenHidden` property
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- typescript
調査の方向性
READMEから始めて、プロパティ openWhenHidden のドキュメントを見つけてください。これを true に設定すると、ブラウザのドキュメントが非表示の間も SSE ストリーミングが維持されることを説明する注記を追加し、その後、その文言がプロパティのデフォルト動作を正確に反映していることを確認してください。
索引モデルが issue の本文から書いたものです。
説明
The default for openWhenHidden is false. This means that the SSE will abort on the client side if the document is hidden, however the default SSE behaviour is that the SSE will continue even if the document is hidden.
Since this is different then normal SSE, I think there should be something in the readme that says something along the lines of "To continue SSE streaming when browser is hidden, set openWhenHidden flag to true". I'm happy to do so if this is approved.
Thank you!
- 主要言語
- TypeScript
- スター
- 2.9k
- フォーク
- 197
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Azure/fetch-event-source のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 28/100
Azure/fetch-event-source#102 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
Azure/fetch-event-source#101 · コメント 3 件 ·
-
When aborting the event source using abort controller, no callbacks (onError / onClose) are firedオープン
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
Azure/fetch-event-source#100 · コメント 1 件 · リアクション 5 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
Azure/fetch-event-source#99 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
Azure/fetch-event-source#98 · リアクション 9 件 ·
Azure/fetch-event-source の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
getsentry/sentry-conventions#732 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
status:in-linear status:team-assigned team:nodes
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
motiondivision/motion#3955 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
equinor/prisma-decision-web#919 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 83/100