Document when an API is guaranteed to be synchronous
メンテナーはふだん 1 日以内に返信
@ArjunCodess がすでに取り組んでいます。
2026年9月19日 から。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Start with the API documentation for Effect.runSync, PubSub.unbounded, Effect.catch, and Scope.addFinalizer, and compare how their synchronous behavior is currently described. Identify the conditions that guarantee synchronous completion and document those guarantees so users can assess whether runSync remains safe across minor updates.
索引モデルが issue の本文から書いたものです。
説明
What is the problem this feature would solve?
This would allow more confident use of Effect.runSync etc.
For example, if I'm interfacing with some non-effect code and just want a PubSub available synchronously (maybe in a custom HTML element constructor), I've found I can do:
import { Effect, PubSub } from 'effect';
const pubSub = Effect.runSync(PubSub.unbounded());
The question is: can I rely on this to work after a minor version update?
What is the feature you are proposing to solve the problem?
Update the API documentation to state when an Effect produced by the library is guaranteed to run synchronously and under which conditions.
For example,
- Does
PubSub.unbounded()complete synchronously? - Does
Effect.catch(self, f)complete synchronously ifselfcompletes synchronously? - Does
Scope.addFinalizer(self, finalizer)complete synchronously ifselfis not closed?
I assume the answer to these is yes, but the API documentation doesn't guarantee that, so I can't be certain that invocations of Effect.runSync won't be broken after a non-breaking effect update.
What alternatives have you considered?
No response
- 主要言語
- TypeScript
- スター
- 16.7k
- フォーク
- 808
- 平均マージ
- 10時間 33分
- マージ済み PR（30日）
- 830
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Effect-TS/effect のほかの issue
-
RpcTest.makeClient: accept disableFatalDefects対応中かも @effect-bot が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Effect-TS/effect#9893 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
`HttpApiSchema.Upgrade`: allow a regular success for servers that don't upgrade対応中かも @effect-bot が今日担当しました。 オープンdocker-made-me-do-it enhancement
Effect-TS/effect#9912 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
docker-made-me-do-it enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
メンテナーはふだん 1 日以内に返信
-
`HttpApiSchema`: stream bodies in a custom framing対応中かも @effect-bot が今日担当しました。 オープンdocker-made-me-do-it enhancement
Effect-TS/effect#9910 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
`HttpApiSchema` streams: declare every media type a stream can be sent as対応中かも @effect-bot が今日担当しました。 オープンdocker-made-me-do-it enhancement
Effect-TS/effect#9909 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
Effect-TS/effect の issue をすべて見る
似ている issue
-
bug require-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
expressjs/expressjs.com#2549 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
umami-software/umami#4686 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
[Bug]: Device screenshot fails with 500 on iPhone Duo (Xcode 27.2): serve-sim calls simctl without --display対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
pingdotgg/t3code#24900 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
inu-appcenter/UNIDorm-web#411 ·
メンテナーはふだん 1 日以内に返信
-
🐛 bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信