Effect-TS API 文档查询工具 - 快速查找函数式编程TypeScript库官方文档

API Documentation Lookup by andrueandersoncs/claude-skill-effect-ts

7 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/andrueandersoncs/claude-skill-effect-ts --skill 'API Documentation Lookup'

函数式编程 TypeScript 技术文档

🇨🇳中文介绍

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`

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

步骤 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: "查找所有以 'catch' 开头的错误处理函数。包括 catchAll、catchTag、catchTags、catchSome 等，以及它们的签名和用途。"
)

使用这些提示模式来有效提取文档：

对于函数签名：

"查找 {functionName} 的完整类型签名。如果存在重载，请包含所有重载。"

对于使用示例：

"查找 {functionName} 的文档和代码示例。重点关注实际使用模式。"

对于理解参数：

"解释 {functionName} 的参数和选项。每个参数的作用是什么？"

对于查找相关函数：

"列出此模块中与 {topic} 相关的所有函数。包括简要描述。"

对于模块概览：

"提供此模块的概览。主要有哪些函数和类型类别？"

提示要具体 - 准确询问你需要的内容（签名、示例、参数）
使用正确的模块 - Effect 函数在 Effect.ts 中，Schema 函数在 Schema.ts 中，依此类推
检查相关函数 - 文档包含指向相关函数的"参见"链接
查找示例 - 大多数函数都包含带有预期输出的实际代码示例
注意版本信息 - 函数会显示"Since v2.0.0"或类似的版本信息

主文档索引位于：

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

如果不确定特定 API 在哪个模块中，可使用此索引来发现可用的包和模块。

从正确的模块开始 - 在获取之前确定 API 所在的模块
使用针对性提示 - 询问具体信息（签名、示例、参数）
检查重载 - 许多 Effect 函数有多个签名
查找"Since"注解 - 验证 API 在你的 Effect 版本中是否可用

有关 API 签名之外的全面 Effect 文档，请查阅 ${CLAUDE_PLUGIN_ROOT}/references/llms-full.txt，其中包含教程、指南和深入解释。

🇺🇸English

Effect-TS API Documentation Lookup

Overview

Use WebFetch to retrieve API documentation directly from the official Effect-TS documentation site at https://effect-ts.github.io/effect/.

URL Patterns

Core Effect Modules

For modules in the main effect package:

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

Common modules:

Module	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`

Scoped Packages

For @effect/* packages:

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

Examples:

Package	Module	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

How to Look Up Documentation

Step 1: Identify the Module

Determine which module contains the API:

Effect.map → Effect module
Schema.Struct → Schema module
Stream.fromIterable → Stream module
Layer.provide → Layer module

Step 2: Construct the URL

Use the URL pattern for the identified module:

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

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

Step 3: Fetch with Targeted Prompt

Use WebFetch with a specific prompt to extract the relevant information:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "Find the documentation for Effect.retry. Include the function signature, description, parameters, and any usage examples."
)

Example Queries

Looking up a specific function

User asks: "What are the parameters for Effect.retry?"

Action:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "Find documentation for the retry function. Include its complete type signature, all parameters and options, and usage examples."
)

Looking up a type/interface

User asks: "What fields does Schedule have?"

Action:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Schedule.ts.html",
  prompt: "Describe the Schedule type and its main combinators. List common schedule functions like exponential, spaced, recurs, etc."
)

Looking up a module overview

User asks: "What functions are available in the Stream module?"

Action:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Stream.ts.html",
  prompt: "List the main categories of functions in this module with brief descriptions of each category."
)

Looking up related functions

User asks: "What are all the catch* functions in Effect?"

Action:

WebFetch(
  url: "https://effect-ts.github.io/effect/effect/Effect.ts.html",
  prompt: "Find all error handling functions that start with 'catch'. Include catchAll, catchTag, catchTags, catchSome, etc. with their signatures and purposes."
)

Prompt Patterns

Use these prompt patterns for effective documentation extraction:

For function signatures:

"Find the complete type signature for {functionName}. Include all overloads if they exist."

For usage examples:

"Find documentation and code examples for {functionName}. Focus on practical usage patterns."

For understanding parameters:

"Explain the parameters and options for {functionName}. What does each parameter do?"

For finding related functions:

"List all functions related to {topic} in this module. Include brief descriptions."

For module overview:

"Provide an overview of this module. What are the main categories of functions and types?"

Tips

Be specific in prompts - Ask for exactly what you need (signature, examples, parameters)
Use the right module - Effect functions are in Effect.ts, Schema functions in Schema.ts, etc.
Check related functions - The docs include "See also" links to related functions
Look for examples - Most functions include practical code examples with expected output
Note version info - Functions show "Since v2.0.0" or similar version information

Documentation Site Index

The main documentation index is at:

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

Use this to discover available packages and modules if unsure which module contains a specific API.

Best Practices

Start with the right module - Identify which module contains the API before fetching
Use targeted prompts - Ask for specific information (signature, examples, parameters)
Check for overloads - Many Effect functions have multiple signatures
Look for "Since" annotations - Verify the API is available in your Effect version

Additional Resources

For comprehensive Effect documentation beyond API signatures, consult ${CLAUDE_PLUGIN_ROOT}/references/llms-full.txt which contains tutorials, guides, and in-depth explanations.

Weekly Installs

Repository

andrueandersonc…ffect-ts

GitHub Stars

First Seen

Jan 1, 1970

Security Audits

Gen Agent Trust HubPass SocketPass SnykWarn

论文复现上下文解析器 - 解决AI论文复现中的关键信息缺口与冲突检测

4,200 周安装

Effect-TS API 文档查询工具 - 快速查找函数式编程TypeScript库官方文档

🇨🇳中文介绍

Effect-TS API 文档查询

概述

URL 模式

核心 Effect 模块

相关 Skills

作用域包

如何查询文档

步骤 1：识别模块

步骤 2：构建 URL

步骤 3：使用针对性提示进行获取

查询示例

查找特定函数

查找类型/接口

查找模块概览

查找相关函数

提示模式

对于函数签名：

对于使用示例：

对于理解参数：

对于查找相关函数：

对于模块概览：

提示

文档站点索引

最佳实践

其他资源

🇺🇸English

Effect-TS API Documentation Lookup

Overview

URL Patterns

Core Effect Modules

Scoped Packages

How to Look Up Documentation

Step 1: Identify the Module

Step 2: Construct the URL

Step 3: Fetch with Targeted Prompt

Example Queries

Looking up a specific function

Looking up a type/interface

Looking up a module overview

Looking up related functions

Prompt Patterns

For function signatures:

For usage examples:

For understanding parameters:

For finding related functions:

For module overview:

Tips

Documentation Site Index

Best Practices

Additional Resources

最新 Skills