Search documentation

Search by topic, API name, or import path.

GitHub ↗

Module / v2.0.0-beta.7

@typed/fx/RefCause

11 unique exports available through this public import path, including their members and aliases.

import * as RefCause from "@typed/fx/RefCause";

Constructors

  • make

    function

    Creates a new RefCause from a Cause, Effect, or Fx.

Derived queries

  • reasons

    variable

    Get the reasons array of the current state of a RefCause.

  • size

    variable

    Get the size (number of failures) of the current state of a RefCause.

State models

  • RefCause

    interface

    A RefCause is a RefSubject specialized over a Cause value.

State predicates

  • hasDies

    variable

    Check if the current state of a RefCause has a Die.

  • hasFails

    variable

    Check if the current state of a RefCause has a Fail.

  • hasInterrupts

    variable

    Check if the current state of a RefCause has an Interrupt.

  • isEmpty

    variable

    Check if the current state of a RefCause is empty.

State updates

  • setDie

    variable

    Set the current state of a RefCause to a Die cause.

  • setFail

    variable

    Set the current state of a RefCause to a Fail cause.

  • setInterrupt

    variable

    Set the current state of a RefCause to an Interrupt cause.