Function expectToBeRight

  • expectToBeRight<A, E>(
        value: undefined | Either<E, A>,
    ): asserts value is Readonly<{ isRight: true; right: A }>

  • Asserts and narrows the type of the provided Either value to Right.

    Type Parameters

    • A
    • E

    Parameters

    • value: undefined | Either<E, A>

      The Either value to check

    Returns asserts value is Readonly<{ isRight: true; right: A }>

    Throws

    If the value is undefined or not a Right

Settings

Member Visibility