fp-ts Quick Reference
Selective Reading Rule
Start with:
references/senior-master-standard.mdreferences/usage-routing.mdreferences/quality-checklist.md
Then load only the inherited docs, scripts, assets, or examples that match the user's actual task.
When to Use
- You need help choosing between
Option, Either, Task, TaskEither, or related fp-ts types.
- The task is about imports, decision guidance, or selecting the right abstraction for a TypeScript flow.
- You want a compact reference for common fp-ts type choices and patterns.
Which Type Should I Use?
Is the operation async?
├─ NO: Does it involve errors?
│ ├─ YES → Either<Error, Value>
│ └─ NO: Might value be missing?
│ ├─ YES → Option<Value>
│ └─ NO → Just use the value
└─ YES: Does it involve errors?
├─ YES → TaskEither<Error, Value>
└─ NO: Might value be missing?
├─ YES → TaskOption<Value>
└─ NO → Task<Value>
Common Imports
// Core
import { pipe, flow } from 'fp-ts/function'
// Types
import * as O from 'fp-ts/Option' // Maybe exists
import * as E from 'fp-ts/Either' // Success or failure
import * as TE from 'fp-ts/TaskEither' // Async + failure
import * as T from 'fp-ts/Task' // Async (no failure)
import * as A from 'fp-ts/Array' // Array utilities
One-Line Patterns
| Need |
Code |
| Wrap nullable |
O.fromNullable(value) |
| Default value |
O.getOrElse(() => default) |
| Transform if exists |
O.map(fn) |
| Chain optionals |
O.flatMap(fn) |
| Wrap try/catch |
E.tryCatch(() => risky(), toError) |
| Wrap async |
TE.tryCatch(() => fetch(url), toError) |
| Run pipe |
pipe(value, fn1, fn2, fn3) |
Pattern Match
// Option
pipe(maybe, O.match(
() => 'nothing',
(val) => `got ${val}`
))
// Either
pipe(result, E.match(
(err) => `error: ${err}`,
(val) => `success: ${val}`
))
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
1---2name: fp-types-ref3description: ALWAYS use this when the user mentions FP Types REF, asks to build, debug, review, document, automate, test, configure, migrate, or make decisions in this domain, or the task clearly depends on FP Types REF; scope: Quick reference for fp-ts types. Apply the bundled workflow, references, scripts, Senior Master standard, and Codex strict review gate before final output.4---56# fp-ts Quick Reference78## Selective Reading Rule910Start with:1112- `references/senior-master-standard.md`13- `references/usage-routing.md`14- `references/quality-checklist.md`1516Then load only the inherited docs, scripts, assets, or examples that match the user's actual task.1718## When to Use19- You need help choosing between `Option`, `Either`, `Task`, `TaskEither`, or related fp-ts types.20- The task is about imports, decision guidance, or selecting the right abstraction for a TypeScript flow.21- You want a compact reference for common fp-ts type choices and patterns.2223## Which Type Should I Use?2425```26Is the operation async?27├─ NO: Does it involve errors?28│ ├─ YES → Either<Error, Value>29│ └─ NO: Might value be missing?30│ ├─ YES → Option<Value>31│ └─ NO → Just use the value32└─ YES: Does it involve errors?33 ├─ YES → TaskEither<Error, Value>34 └─ NO: Might value be missing?35 ├─ YES → TaskOption<Value>36 └─ NO → Task<Value>37```3839## Common Imports4041```typescript42// Core43import { pipe, flow } from 'fp-ts/function'4445// Types46import * as O from 'fp-ts/Option' // Maybe exists47import * as E from 'fp-ts/Either' // Success or failure48import * as TE from 'fp-ts/TaskEither' // Async + failure49import * as T from 'fp-ts/Task' // Async (no failure)50import * as A from 'fp-ts/Array' // Array utilities51```5253## One-Line Patterns5455| Need | Code |56|------|------|57| Wrap nullable | `O.fromNullable(value)` |58| Default value | `O.getOrElse(() => default)` |59| Transform if exists | `O.map(fn)` |60| Chain optionals | `O.flatMap(fn)` |61| Wrap try/catch | `E.tryCatch(() => risky(), toError)` |62| Wrap async | `TE.tryCatch(() => fetch(url), toError)` |63| Run pipe | `pipe(value, fn1, fn2, fn3)` |6465## Pattern Match6667```typescript68// Option69pipe(maybe, O.match(70 () => 'nothing',71 (val) => `got ${val}`72))7374// Either75pipe(result, E.match(76 (err) => `error: ${err}`,77 (val) => `success: ${val}`78))79```8081## Limitations82- Use this skill only when the task clearly matches the scope described above.83- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.84- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
anhvu1107