effect-io-ai

Package: effect
Module: Redactable

Redactable.Redactable

Interface for objects that provide context-aware redacted representations.

When to use

Use to define classes or objects that hold sensitive data and should present a sanitized form when inspected or logged.

Details

The [symbolRedactable] method receives the current fiber’s Context. If no fiber is active, an empty Context is provided.

Example (Masking an API key)

import { Context, Redactable } from "effect"

class ApiKey {
  constructor(readonly raw: string) {}

  [Redactable.symbolRedactable](_ctx: Context.Context<never>) {
    return this.raw.slice(0, 4) + "..."
  }
}

See

• symbolRedactable for the symbol key to implement
• redact to apply redaction to any value
• isRedactable for the type guard for this interface

Signature

export interface Redactable {
  readonly [symbolRedactable]: (context: Context.Context<never>) => unknown
}

Source

Since v3.10.0