effect-io-ai

Package: effect
Module: Cause

Cause.pretty

Formats a Cause as a human-readable string for logging or debugging.

When to use

Use to render a whole cause as one human-readable string for logs or diagnostics.

Details

Delegates to prettyErrors to convert each reason to an Error, then joins their stack traces with newlines. Nested Error.cause chains are rendered inline with indentation:

ErrorName: message
    at ...
    at ... {
  [cause]: NestedError: message
      at ...
}

Span annotations are appended to the relevant stack frames when available.

Gotchas

Rendering an empty cause produces an empty string because there are no errors to render.

Example (Rendering a cause)

import { Cause } from "effect"

const rendered = Cause.pretty(Cause.fail("something went wrong"))
console.log(rendered.includes("something went wrong")) // true

See

• prettyErrors — get the individual Error instances

Signature

declare const pretty: <E>(cause: Cause<E>) => string

Source

Since v2.0.0