Failure · API reference

Import

import { Failure } from "@typed/async-data";

export interface Failure<E> {
    readonly _tag: "Failure";
    readonly cause: Cause.Cause<E>;
    readonly progress?: Progress | undefined;
}

Retaining the complete Effect Cause preserves typed errors, defects, and interruption instead of flattening failure detail.

This plain wrapper acquires no resources; its Cause is persistent, but the wrapper itself is not frozen.

The discriminant for a failed computation.

The literal tag separates failure from absence and loading.

Inherits the resource-free lifetime of its enclosing state.

The complete Effect cause of failure.

Cause preservation keeps defects and interruption observable alongside typed failures.

Inherits the enclosing state’s lifetime; Effect Cause is persistent.

Optional progress for a retry of the failed operation.

Its presence distinguishes a refreshing failure from a settled failure.

Inherits the resource-free lifetime of its enclosing state.

import { failure } from "@typed/async-data"
import { Cause } from "effect"
const state = failure(Cause.fail("offline"))