Skip to content
effect-lookup logo

Effect Library Lookup

effect-lookup

Quick lookup for Effect TypeScript library APIs, patterns, and source code. Use when you need to find Effect functions, understand Effect patterns, or look up implementation details.

SKILL.md

Full skill instructions

Effect Library Lookup

Quick reference for finding and understanding Effect TypeScript library APIs from the local git subtree at docs/​effect/.

When to Use This Skill

Use this skill when:

  • Looking up Effect function signatures or implementations
  • Finding examples of Effect patterns (Effect.gen, Layer, Context, etc.)
  • Understanding how Effect modules work internally
  • Checking API availability or deprecation status
  • Learning Effect idioms from source code

How to Look Up Effect APIs

1. Use the Effect Docs MCP Server (Fastest)

The effect-docs MCP server provides indexed documentation:

mcp__effect-docs__effect_docs_search: Search for Effect concepts
mcp__effect-docs__get_effect_doc: Get specific documentation by ID

2. Search the Git Subtree Source

For implementation details, search the local source at docs/​effect/:

# Find a specific function
grep -r "export const myFunction" docs/​effect/​packages/​effect/​src/

# Find usage patterns
grep -rn "Effect.gen" docs/​effect/​packages/​effect/​src/

# Find type definitions
grep -rn "interface MyType" docs/​effect/​packages/​effect/​src/

3. Read Source Files Directly

Core modules are at: docs/​effect/​packages/​effect/​src/<Module>.ts

Example: To understand Effect.map, read docs/​effect/​packages/​effect/​src/​Effect.ts

Quick Reference

TaskReference
Module categoriesreferences/​modules.md
Common patternsreferences/​patterns.md

Package Structure

docs/​effect/
├── packages/
│   ├── effect/               # Core Effect library
│   │   └── src/              # Source files (Effect.ts, Layer.ts, etc.)
│   ├── platform/             # Cross-platform utilities (HTTP, FileSystem)
│   ├── platform-node/        # Node.js platform implementation
│   ├── platform-browser/     # Browser platform implementation
│   ├── cli/                  # CLI building utilities
│   ├── sql/                  # SQL database utilities
│   ├── sql-pg/               # PostgreSQL implementation
│   ├── sql-kysely/           # Kysely integration
│   ├── rpc/                  # Remote procedure calls
│   ├── cluster/              # Distributed computing
│   ├── opentelemetry/        # OpenTelemetry integration
│   ├── experimental/         # Experimental features
│   └── ai/                   # AI integrations (OpenAI, Anthropic, etc.)

Core Modules Quick Lookup

Effect System

ModuleFilePurpose
EffectEffect.tsCore effect type and combinators
LayerLayer.tsDependency injection layers
ContextContext.tsType-safe service context
ScopeScope.tsResource management
RuntimeRuntime.tsEffect execution

Data Types

ModuleFilePurpose
OptionOption.tsOptional values
EitherEither.tsSuccess/​failure values
ChunkChunk.tsImmutable arrays
HashMapHashMap.tsImmutable hash maps
HashSetHashSet.tsImmutable hash sets
ListList.tsImmutable linked lists

Concurrency

ModuleFilePurpose
FiberFiber.tsLightweight threads
QueueQueue.tsConcurrent queues
RefRef.tsMutable references
SemaphoreSemaphore.tsConcurrency limiting
PubSubPubSub.tsPublish/​subscribe

Schema & Validation

ModuleFilePurpose
SchemaSchema.tsData validation & encoding
ParseResultParseResult.tsParsing results
ArbitraryArbitrary.tsProperty-based testing

Streaming

ModuleFilePurpose
StreamStream.tsEffectful streams
SinkSink.tsStream consumers
ChannelChannel.tsBidirectional streaming

Scheduling & Time

ModuleFilePurpose
ScheduleSchedule.tsRetry/​repeat schedules
DurationDuration.tsTime durations
DateTimeDateTime.tsDate/​time handling
ClockClock.tsTime service
CronCron.tsCron expressions

Configuration

ModuleFilePurpose
ConfigConfig.tsType-safe configuration
ConfigProviderConfigProvider.tsConfiguration sources

Common Lookup Patterns

Find Function Signature

# In Effect.ts, functions are well-documented with JSDoc
grep -A 20 "export const map" docs/​effect/​packages/​effect/​src/​Effect.ts

Find Type Definition

# Look for interface or type alias
grep -n "interface Effect<" docs/​effect/​packages/​effect/​src/​Effect.ts

Find Examples in Tests

# Tests often have practical examples
grep -rn "Effect.gen" docs/​effect/​packages/​effect/​test/

Check Platform APIs

# HTTP client/​server
ls docs/​effect/​packages/​platform/​src/​Http*.ts

# FileSystem
cat docs/​effect/​packages/​platform/​src/​FileSystem.ts

External References

Tips for Effective Lookups

  1. Start with MCP search - Use effect_docs_search for conceptual questions
  2. Read JSDoc comments - Effect source has excellent inline documentation
  3. Check tests for examples - Test files show real usage patterns
  4. Use module tables above - Quickly navigate to the right source file
  5. Platform packages - HTTP, FileSystem, etc. are in @effect/​platform

More skills from majiayu000

xiaohongshu logo
majiayu000/claude-arsenal

xiaohongshu

xiaohongshu

286 148
View
agent-task-conductor logo
majiayu000/claude-skill-registry

agent-task-conductor

Conduct multi-agent task orchestration and workflow coordination.

663 1
View
conductor-setup logo
majiayu000/claude-skill-registry

conductor-setup

Initialize project with Conductor artifacts (product definition,

663 1
View
animation-designer logo
majiayu000/claude-skill-registry

animation-designer

Expert in web animations, transitions, and motion design using Framer Motion and CSS

663 1
View
diagramming logo
majiayu000/claude-skill-registry

diagramming

Creates Mermaid and ASCII diagrams for flowcharts, architecture, ERDs, state machines, mindmaps, and more. Use when user mentions diagram, flowchart, mermaid, ASCII diagram, text diagram, terminal diagram, visualize, C4, mindmap, architecture diagram, sequence diagram, ERD, or needs visual docume...

663 1
View
h3-pg logo
majiayu000/claude-skill-registry-data

h3-pg

PostgreSQL bindings for H3 hexagonal grid system. Use when working with H3 cells in Postgres, including spatial indexing, geometry/geography integration, and raster analysis.

23 1
View
conductor-development logo
majiayu000/claude-skill-registry

conductor-development

Context-Driven Development skill for projects using Conductor. Use this skill when you detect a `conductor/` directory in the project, when working on tasks defined in a `plan.md` file, or when the user asks about tracks, specs, or plans. Automatically applies TDD workflow, tracks task completion...

663 1
View
conductor-status logo
majiayu000/claude-skill-registry

conductor-status

Display project status, active tracks, and next actions

663 1
View
dockerization logo
majiayu000/claude-skill-registry

dockerization

Official Stakpak application containerization standard operating procedure, a step-by-step guidline to properly dockerize applications. This is a rule book curated by the Stakpak Team.

663 1
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View