Effect-TS API ドキュメンテーション検索

概要

WebFetch を使用して、公式 Effect-TS ドキュメンテーションサイト https://effect-ts.github.io/effect/ から API ドキュメンテーションを直接取得します。

URL パターン

コア Effect モジュール

メイン effect パッケージ内のモジュール用:

https://effect-ts.github.io/effect/effect/{Module}.ts.html

よく使用されるモジュール:

モジュール	URL
Effect	https://effect-ts.github.io/effect/effect/Effect.ts.html
Schema	https://effect-ts.github.io/effect/effect/Schema.ts.html
Stream	https://effect-ts.github.io/effect/effect/Stream.ts.html
Layer	https://effect-ts.github.io/effect/effect/Layer.ts.html
Context	https://effect-ts.github.io/effect/effect/Context.ts.html
Schedule	https://effect-ts.github.io/effect/effect/Schedule.ts.html
Fiber	https://effect-ts.github.io/effect/effect/Fiber.ts.html
Queue	https://effect-ts.github.io/effect/effect/Queue.ts.html
Ref	https://effect-ts.github.io/effect/effect/Ref.ts.html
Scope	https://effect-ts.github.io/effect/effect/Scope.ts.html
Option	https://effect-ts.github.io/effect/effect/Option.ts.html
Either	https://effect-ts.github.io/effect/effect/Either.ts.html
Chunk	https://effect-ts.github.io/effect/effect/Chunk.ts.html
HashMap	https://effect-ts.github.io/effect/effect/HashMap.ts.html
HashSet	https://effect-ts.github.io/effect/effect/HashSet.ts.html
Duration	https://effect-ts.github.io/effect/effect/Duration.ts.html
Config	https://effect-ts.github.io/effect/effect/Config.ts.html
ConfigProvider	https://effect-ts.github.io/effect/effect/ConfigProvider.ts.html
Match	https://effect-ts.github.io/effect/effect/Match.ts.html
Data	https://effect-ts.github.io/effect/effect/Data.ts.html
Cause	https://effect-ts.github.io/effect/effect/Cause.ts.html
Exit	https://effect-ts.github.io/effect/effect/Exit.ts.html
Random	https://effect-ts.github.io/effect/effect/Random.ts.html
Clock	https://effect-ts.github.io/effect/effect/Clock.ts.html
Tracer	https://effect-ts.github.io/effect/effect/Tracer.ts.html
Metric	https://effect-ts.github.io/effect/effect/Metric.ts.html
Logger	https://effect-ts.github.io/effect/effect/Logger.ts.html
Sink	https://effect-ts.github.io/effect/effect/Sink.ts.html
PubSub	https://effect-ts.github.io/effect/effect/PubSub.ts.html
Deferred	https://effect-ts.github.io/effect/effect/Deferred.ts.html
Semaphore	https://effect-ts.github.io/effect/effect/Semaphore.ts.html
Request	https://effect-ts.github.io/effect/effect/Request.ts.html
RequestResolver	https://effect-ts.github.io/effect/effect/RequestResolver.ts.html
Cache	https://effect-ts.github.io/effect/effect/Cache.ts.html
TestClock	https://effect-ts.github.io/effect/effect/TestClock.ts.html
Runtime	https://effect-ts.github.io/effect/effect/Runtime.ts.html
ManagedRuntime	https://effect-ts.github.io/effect/effect/ManagedRuntime.ts.html

スコープ付きパッケージ

@effect/* パッケージ用:

https://effect-ts.github.io/effect/{package-name}/{Module}.ts.html

例:

パッケージ	モジュール	URL
@effect/platform	HttpClient	https://effect-ts.github.io/effect/platform/HttpClient.ts.html
@effect/platform	FileSystem	https://effect-ts.github.io/effect/platform/FileSystem.ts.html
@effect/platform	KeyValueStore	https://effect-ts.github.io/effect/platform/KeyValueStore.ts.html
@effect/cli	Command	https://effect-ts.github.io/effect/cli/Command.ts.html
@effect/sql	SqlClient	https://effect-ts.github.io/effect/sql/SqlClient.ts.html

ドキュメンテーション検索方法

ステップ 1: モジュールを特定する

API を含むモジュールを決定します:

• Effect.map → Effect モジュール
• Schema.Struct → Schema モジュール
• Stream.fromIterable → Stream モジュール
• Layer.provide → Layer モジュール

ステップ 2: URL を構築する

特定したモジュール用の URL パターンを使用します:

// Effect.retry 用
const url = "https://effect-ts.github.io/effect/effect/Effect.ts.html"

// Schema.transform 用
const url = "https://effect-ts.github.io/effect/effect/Schema.ts.html"

ステップ 3: ターゲット化されたプロンプトで取得する

特定の情報を抽出するために、ターゲット化されたプロンプトで WebFetch を使用します:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "Effect.retry のドキュメンテーションを見つけてください。関数シグネチャ、説明、パラメータ、使用例を含めてください。"
)

クエリ例

特定の関数を検索する

ユーザーが質問: 「Effect.retry のパラメータは何ですか?」

アクション:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "retry 関数のドキュメンテーションを検索してください。完全な型シグネチャ、すべてのパラメータとオプション、使用例を含めてください。"
)

型/インターフェースを検索する

ユーザーが質問: 「Schedule にはどのようなフィールドがありますか?」

アクション:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Schedule.ts.html",
  prompt: "Schedule 型とそのメインコンビネータについて説明してください。exponential、spaced、recurs などの一般的なスケジュール関数をリストアップしてください。"
)

モジュール概要を検索する

ユーザーが質問: 「Stream モジュールで使用可能な関数は何ですか?」

アクション:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Stream.ts.html",
  prompt: "このモジュール内の関数の主なカテゴリをリストアップし、各カテゴリの簡単な説明を提供してください。"
)

関連する関数を検索する

ユーザーが質問: 「Effect に含まれるすべての catch* 関数は何ですか?」

アクション:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "catchAll、catchTag、catchTags、catchSome など、'catch' で始まるエラーハンドリング関数をすべて見つけてください。シグネチャと目的を含めてください。"
)

プロンプトパターン

ドキュメンテーション抽出を効果的に行うために、これらのプロンプトパターンを使用します:

関数シグネチャ用:

"{functionName} の完全な型シグネチャを見つけてください。複数のオーバーロードが存在する場合は含めてください。"

使用例用:

"{functionName} のドキュメンテーションとコード例を見つけてください。実践的な使用パターンに焦点を当ててください。"

パラメータを理解する用:

"{functionName} のパラメータとオプションについて説明してください。各パラメータは何をしますか?"

関連する関数を検索用:

"このモジュール内の {topic} に関連するすべての関数をリストアップしてください。簡単な説明を含めてください。"

モジュール概要用:

"このモジュールの概要を提供してください。関数と型の主なカテゴリは何ですか?"

ヒント

1. プロンプトは具体的に - 必要なもの (シグネチャ、例、パラメータ) を正確に聞いてください
2. 正しいモジュールを使用する - Effect 関数は Effect.ts 内、Schema 関数は Schema.ts 内など
3. 関連する関数を確認する - ドキュメンテーションには関連する関数への「参照」リンクが含まれています
4. 例を探す - ほとんどの関数には期待される出力を伴う実践的なコード例が含まれています
5. バージョン情報に注意 - 関数には「Since v2.0.0」などのバージョン情報が表示されています

ドキュメンテーションサイトインデックス

メインドキュメンテーションインデックスは以下の場所にあります:

https://effect-ts.github.io/effect/

特定の API を含むモジュールが不明な場合、利用可能なパッケージとモジュールを探索するために使用します。

ベストプラクティス

1. 正しいモジュールから始める - フェッチする前に API を含むモジュールを特定してください
2. ターゲット化されたプロンプトを使用する - 特定の情報 (シグネチャ、例、パラメータ) を要求してください
3. オーバーロードを確認する - 多くの Effect 関数は複数のシグネチャを持っています
4. 「Since」アノテーションを確認する - API が Effect バージョンで利用可能であることを確認してください

追加リソース

API シグネチャを超えた包括的な Effect ドキュメンテーションについては、チュートリアル、ガイド、詳細な説明を含む ${CLAUDE_PLUGIN_ROOT}/references/llms-full.txt を参照してください。