‹ 首页

typescript-functional-patterns

@martinffx · 收录于 1 周前

Functional programming patterns for reliable TypeScript. Use when modeling state machines, discriminated unions, Result/Option types, branded types, or building type-safe domain models.

适合你,如果常用 TypeScript 编写复杂业务逻辑或状态管理

/ 下载安装
typescript-functional-patterns.skill双击,或拖进 Claude 桌面版 / Cowork,即完成安装↓ .skill↓ .zip
用别的 agent?下载 .zip 解压,把文件夹放进它的技能目录
Claude Code~/.claude/skills/(项目级 .claude/skills/)
Codex CLI~/.codex/skills/
Cursor自动读取上面两处目录
其他工具见其文档的「skills」目录;两个下载是同一份文件,只是名字不同
/ 通过 npx 安装 校验哈希
npx oh-my-skill add martinffx/atelier/typescript-functional-patterns
/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- martinffx/atelier/typescript-functional-patterns
/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify martinffx/atelier/typescript-functional-patterns
安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
34GitHub stars
~2.7K最小装载
~14.9K含声明引用
~14.9K文本包总量
镜像托管

怎么用

技能原文 SKILL.md作者撰写 · MIT · e5f96ba

Functional Patterns for Reliable TypeScript

Build reliable systems using Algebraic Data Types (ADTs), discriminated unions, Result/Option types, and branded types. These patterns enable the compiler to prove correctness, prevent runtime errors, and make illegal states unrepresentable.

Why Functional Patterns?

Reliability through types: Use the type system to encode business rules, making invalid states impossible to construct. The compiler becomes your safety net, catching errors at build time rather than runtime.

Key benefits:

  • Exhaustiveness checking prevents missing cases
  • Impossible states become unrepresentable
  • Business logic encoded in types, not runtime checks
  • Refactoring becomes safe and mechanical
  • Self-documenting code through types
Quick Reference

For detailed patterns and examples, see:

  • [ADTs (Algebraic Data Types)](./references/adts.md) - Sum types, product types, discriminated unions
  • [Option & Result](./references/option-result.md) - Type-safe error handling and nullable values
  • [Branded Types](./references/branded-types.md) - Smart constructors and nominal typing
  • [Migration Guide](./references/migration-guide.md) - Step-by-step adoption playbook
Core Patterns Overview
1. Discriminated Unions (Sum Types)

Model "one of several variants" with exhaustive pattern matching:

type PaymentMethod =
  | { kind: "card"; last4: string; brand: string }
  | { kind: "ach"; accountNumber: string; routingNumber: string }
  | { kind: "wallet"; provider: "apple" | "google" }

function processPayment(method: PaymentMethod): void {
  switch (method.kind) {
    case "card":
      // TypeScript knows: method.last4 and method.brand exist
      return processCard(method.last4, method.brand)
    case "ach":
      // TypeScript knows: method.accountNumber and method.routingNumber exist
      return processACH(method.accountNumber, method.routingNumber)
    case "wallet":
      // TypeScript knows: method.provider exists
      return processWallet(method.provider)
    default:
      assertNever(method) // Compiler error if cases missing
  }
}
2. Option Type (Nullable Values)

Explicit handling of "value may be absent":

type Option<T> = { _tag: "None" } | { _tag: "Some"; value: T }

function findUser(id: string): Option<User> {
  const user = database.get(id)
  return user ? Some(user) : None
}

const result = findUser("123")
switch (result._tag) {
  case "Some":
    console.log(result.value.name) // Type-safe access
    break
  case "None":
    console.log("User not found")
    break
}
3. Result Type (Error Handling)

Explicit error handling without exceptions:

type Result<T, E> = { _tag: "Ok"; value: T } | { _tag: "Err"; error: E }

function parseConfig(raw: string): Result<Config, ParseError> {
  try {
    const data = JSON.parse(raw)
    return Ok(validateConfig(data))
  } catch (e) {
    return Err({ message: "Invalid JSON", cause: e })
  }
}

const result = parseConfig(rawConfig)
switch (result._tag) {
  case "Ok":
    startServer(result.value)
    break
  case "Err":
    logger.error(result.error.message)
    break
}
4. Branded Types (Type-Safe Units)

Prevent unit confusion and invalid values:

type Brand<K, T> = K & { __brand: T }
type Cents = Brand<number, "Cents">
type Dollars = Brand<number, "Dollars">

const Cents = (n: number): Cents => {
  if (!Number.isInteger(n) || n < 0) throw new Error("Invalid cents")
  return n as Cents
}

const Dollars = (n: number): Dollars => {
  if (n < 0) throw new Error("Invalid dollars")
  return n as Dollars
}

// Compiler prevents mixing units:
const price: Cents = Cents(100)
const budget: Dollars = Dollars(10)
const total: Cents = price + budget // Type error! Cannot mix Cents and Dollars
When to Use
Use Discriminated Unions When:
  • Modeling state machines (pending → settled → reconciled)
  • Representing mutually exclusive variants (payment methods, user roles)
  • Building domain models with distinct states
  • Replacing boolean flags with explicit states
Use Option When:
  • Value may be absent (but absence is expected/valid)
  • Replacing null or undefined checks
  • Chaining operations that may fail to find values
  • Making nullability explicit in APIs
Use Result When:
  • Operation may fail with recoverable errors
  • You need to propagate error context
  • Replacing try/catch for expected failures
  • Building error handling into function signatures
Use Branded Types When:
  • Preventing unit confusion (cents vs dollars, ms vs seconds)
  • Enforcing validation invariants (email format, positive numbers)
  • Creating type-safe IDs (UserId vs OrderId)
  • Domain-driven design with value objects
Quick Start - Paste-Ready Helpers

Copy these into your project to start using functional patterns:

// ============================================
// Option Type
// ============================================
type None = { _tag: "None" }
type Some<T> = { _tag: "Some"; value: T }
type Option<T> = None | Some<T>

const None: None = { _tag: "None" }
const Some = <T>(value: T): Option<T> => ({ _tag: "Some", value })

// Utilities
const isNone = <T>(opt: Option<T>): opt is None => opt._tag === "None"
const isSome = <T>(opt: Option<T>): opt is Some<T> => opt._tag === "Some"

const getOrElse = <T>(opt: Option<T>, defaultValue: T): T =>
  opt._tag === "Some" ? opt.value : defaultValue

const map = <T, U>(opt: Option<T>, fn: (value: T) => U): Option<U> =>
  opt._tag === "Some" ? Some(fn(opt.value)) : None

const flatMap = <T, U>(opt: Option<T>, fn: (value: T) => Option<U>): Option<U> =>
  opt._tag === "Some" ? fn(opt.value) : None

// ============================================
// Result Type
// ============================================
type Ok<T> = { _tag: "Ok"; value: T }
type Err<E> = { _tag: "Err"; error: E }
type Result<T, E> = Ok<T> | Err<E>

const Ok = <T>(value: T): Result<T, never> => ({ _tag: "Ok", value })
const Err = <E>(error: E): Result<never, E> => ({ _tag: "Err", error })

// Utilities
const isOk = <T, E>(result: Result<T, E>): result is Ok<T> => result._tag === "Ok"
const isErr = <T, E>(result: Result<T, E>): result is Err<E> => result._tag === "Err"

const mapResult = <T, U, E>(result: Result<T, E>, fn: (value: T) => U): Result<U, E> =>
  result._tag === "Ok" ? Ok(fn(result.value)) : result

const flatMapResult = <T, U, E>(
  result: Result<T, E>,
  fn: (value: T) => Result<U, E>
): Result<U, E> =>
  result._tag === "Ok" ? fn(result.value) : result

// ============================================
// Exhaustiveness Checking
// ============================================
const assertNever = (x: never): never => {
  throw new Error(`Unhandled variant: ${JSON.stringify(x)}`)
}

// ============================================
// Branded Types
// ============================================
type Brand<K, T> = K & { __brand: T }

// Example: Cents (integer cents to prevent floating point errors)
type Cents = Brand<number, "Cents">
const Cents = (n: number): Cents => {
  if (!Number.isInteger(n)) throw new Error("Cents must be integer")
  if (n < 0) throw new Error("Cents cannot be negative")
  return n as Cents
}

// Example: Email (validated email address)
type Email = Brand<string, "Email">
const Email = (s: string): Email => {
  if (!/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(s)) throw new Error("Invalid email")
  return s as Email
}

// Example: Millis (timestamp in milliseconds)
type Millis = Brand<number, "Millis">
const Millis = (n: number): Millis => {
  if (n < 0) throw new Error("Millis cannot be negative")
  return n as Millis
}
Guidelines
Pattern Matching Best Practices
  1. Always use assertNever in default case for exhaustiveness checking: ```typescript switch (variant.kind) { case "a": return handleA(variant) case "b": return handleB(variant) default: assertNever(variant) // Compiler error if cases missing } ```
  1. Use discriminant field consistently (kind, type, _tag): ```typescript // Good: consistent discriminant type Result<T, E> = { _tag: "Ok"; value: T } | { _tag: "Err"; error: E }

// Avoid: mixing discriminants type Bad = { kind: "a" } | { type: "b" } // Inconsistent! ```

  1. Narrow types early to unlock type safety: ```typescript if (result._tag === "Ok") { // TypeScript knows: result.value exists return result.value.data } ```
Error Handling Strategy
  1. Use Option for expected absence: ```typescript function findUser(id: string): Option<User> ```
  1. Use Result for recoverable errors: ```typescript function parseConfig(raw: string): Result<Config, ParseError> ```
  1. Use exceptions for programmer errors: ```typescript function unreachable(message: string): never { throw new Error(Unreachable: ${message}) } ```
Branded Types Guidelines
  1. Validate in smart constructor: ```typescript const PositiveInt = (n: number): PositiveInt => { if (!Number.isInteger(n) || n <= 0) throw new Error("Must be positive integer") return n as PositiveInt } ```
  1. Use branded types for domain concepts: ```typescript type UserId = Brand<string, "UserId"> type OrderId = Brand<string, "OrderId"> // Compiler prevents: const userId: UserId = orderId ```
  1. Prevent unit confusion: ```typescript type Seconds = Brand<number, "Seconds"> type Millis = Brand<number, "Millis"> // Compiler prevents: const s: Seconds = millis ```
Migration Strategy

Start small and expand:

  1. New features: Use functional patterns from day one
  2. Bug fixes: Refactor to discriminated unions when touching code
  3. High-risk areas: Prioritize financial calculations, state machines
  4. Team adoption: Share paste-ready helpers, pair on first implementations

Enable TypeScript strict mode flags:

  • strictNullChecks: true - Make nullability explicit
  • noImplicitReturns: true - Ensure all code paths return
  • strictFunctionTypes: true - Safer function signatures
Examples by Domain
State Machine (Transaction Lifecycle)
type TxnState =
  | { kind: "pending"; createdAt: Millis }
  | { kind: "settled"; ledgerId: string; settledAt: Millis }
  | { kind: "failed"; reason: FailureReason; failedAt: Millis }
  | { kind: "reversed"; originalLedgerId: string; reversedAt: Millis }

function canReverse(state: TxnState): boolean {
  switch (state.kind) {
    case "pending": return false
    case "settled": return true
    case "failed": return false
    case "reversed": return false
    default: assertNever(state)
  }
}
Configuration Parsing
type ConfigError = { field: string; message: string }

function parsePort(raw: unknown): Result<number, ConfigError> {
  if (typeof raw !== "number") {
    return Err({ field: "port", message: "must be number" })
  }
  if (raw < 1 || raw > 65535) {
    return Err({ field: "port", message: "must be 1-65535" })
  }
  return Ok(raw)
}
Financial Calculations
type Cents = Brand<number, "Cents">

function addCents(a: Cents, b: Cents): Cents {
  return Cents(a + b) // Smart constructor validates result
}

function calculateFee(amount: Cents, bps: number): Cents {
  const feeAmount = Math.round((amount * bps) / 10000)
  return Cents(feeAmount)
}
Further Reading
  • [ADT Reference](./references/adts.md) - Deep dive on sum types, product types, and pattern matching
  • [Option & Result Reference](./references/option-result.md) - Comprehensive error handling patterns
  • [Branded Types Reference](./references/branded-types.md) - Advanced nominal typing techniques
  • [Migration Guide](./references/migration-guide.md) - Step-by-step adoption playbook
Credits

These patterns are inspired by Why Reliability Demands Functional Programming, ADTs, Safety and Critical Infrastructure by Rastrian. The blog post explores how functional programming techniques and Algebraic Data Types enable building reliable systems in critical infrastructure contexts.

When This Skill Loads

This skill automatically loads when discussing:

  • Discriminated unions and sum types
  • State machine modeling
  • Result/Option types and error handling
  • Branded types and smart constructors
  • Type-safe domain models
  • Making illegal states unrepresentable
  • Functional programming in TypeScript
按 MIT 许可原样转载,未经改动 · 在 GitHub 查看 →

评论

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。