Class FailureOr<TValue>

Readonly isFailure

Readonly isSuccess

failures

• get failures(): Failure[]

• Gets the list of failures. If the state is a success, this will return a list with a single failure.

  Returns Failure[]

  Memberof

  FailureOr

failuresOrEmptyList

• get failuresOrEmptyList(): Failure[]

• Gets the list of failures. If the state is a success, this will return an empty list.

  Returns Failure[]

  Memberof

  FailureOr

firstFailure

• get firstFailure(): Failure

• Gets the first error. If the state is a success, this will return a failure indicating that no first failure exists.

  Returns Failure

  Memberof

  FailureOr

value

• get value(): TValue

• Gets the value. If the state is a failure, this will throw an error.

  Returns TValue

  Throws

  If the state is a failure

  Memberof

  FailureOr

else

• else(onFailure): FailureOr<TValue>

• If the state is a failure, the onFailure callback will be executed and its result is returned.

  Parameters

  • onFailure: ((failures) => FailureOr<TValue>)

    • • (failures): FailureOr<TValue>

      • Parameters

        • failures: Failure[]

        Returns FailureOr<TValue>

  Returns FailureOr<TValue>

  {FailureOr}

  Memberof

  FailureOr

map

• map<TNextValue>(onValue): FailureOr<TNextValue>

• If the state is a success, the onValue callback will be executed and its result is returned.

  Type Parameters

  • TNextValue

  Parameters

  • onValue: ((value) => FailureOr<TNextValue>)

    • • (value): FailureOr<TNextValue>

      • Parameters

        • value: TValue

        Returns FailureOr<TNextValue>

  Returns FailureOr<TNextValue>

  {FailureOr}

  Memberof

  FailureOr

match

• match<TResult>(onValue, onFailure): TResult

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed and its result is returned. If the state is a failure, the onFailure callback will be executed and its result is returned.

  Type Parameters

  • TResult

  Parameters

  • onValue: ((value) => TResult)

    • • (value): TResult

      • Parameters

        • value: TValue

        Returns TResult

  • onFailure: ((failures) => TResult)

    • • (failures): TResult

      • Parameters

        • failures: Failure[]

        Returns TResult

  Returns TResult

  {TResult}

  Memberof

  FailureOr

matchAsync

• matchAsync<TResult>(onValue, onFailure): Promise<TResult>

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed and its result is returned. If the state is a failure, the onFailure callback will be executed and its result is returned.

  Type Parameters

  • TResult

  Parameters

  • onValue: ((value) => Promise<TResult>)

    • • (value): Promise<TResult>

      • Parameters

        • value: TValue

        Returns Promise<TResult>

  • onFailure: ((failures) => Promise<TResult>)

    • • (failures): Promise<TResult>

      • Parameters

        • failures: Failure[]

        Returns Promise<TResult>

  Returns Promise<TResult>

  {Promise}

  Memberof

  FailureOr

matchFirst

• matchFirst<TResult>(onValue, onFailure): TResult

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed and its result is returned. If the state is a failure, the onFailure callback will be executed using the first failure as input and its result is returned.

  Type Parameters

  • TResult

  Parameters

  • onValue: ((value) => TResult)

    • • (value): TResult

      • Parameters

        • value: TValue

        Returns TResult

  • onFailure: ((failure) => TResult)

    • • (failure): TResult

      • Parameters

        • failure: Failure

        Returns TResult

  Returns TResult

  {TResult}

  Memberof

  FailureOr

matchFirstAsync

• matchFirstAsync<TResult>(onValue, onFailure): Promise<TResult>

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed and its result is returned. If the state is a failure, the onFailure callback will be executed using the first failure as input and its result is returned.

  Type Parameters

  • TResult

  Parameters

  • onValue: ((value) => Promise<TResult>)

    • • (value): Promise<TResult>

      • Parameters

        • value: TValue

        Returns Promise<TResult>

  • onFailure: ((failure) => Promise<TResult>)

    • • (failure): Promise<TResult>

      • Parameters

        • failure: Failure

        Returns Promise<TResult>

  Returns Promise<TResult>

  {Promise}

  Memberof

  FailureOr

switch

• switch(onValue, onFailure): void

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed. If the state is a failure, the onFailure callback will be executed.

  Parameters

  • onValue: ((value) => void)

    • • (value): void

      • Parameters

        • value: TValue

        Returns void

  • onFailure: ((failures) => void)

    • • (failures): void

      • Parameters

        • failures: Failure[]

        Returns void

  Returns void

  Memberof

  FailureOr

switchAsync

• switchAsync(onValue, onFailure): Promise<void>

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed. If the state is a failure, the onFailure callback will be executed.

  Parameters

  • onValue: ((value) => Promise<void>)

    • • (value): Promise<void>

      • Parameters

        • value: TValue

        Returns Promise<void>

  • onFailure: ((failures) => Promise<void>)

    • • (failures): Promise<void>

      • Parameters

        • failures: Failure[]

        Returns Promise<void>

  Returns Promise<void>

  {Promise}

  Memberof

  FailureOr

switchFirst

• switchFirst(onValue, onFailure): void

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed. If the state is a failure, the onFailure callback will be executed using the first failure as input.

  Parameters

  • onValue: ((value) => void)

    • • (value): void

      • Parameters

        • value: TValue

        Returns void

  • onFailure: ((failure) => void)

    • • (failure): void

      • Parameters

        • failure: Failure

        Returns void

  Returns void

  Memberof

  FailureOr

switchFirstAsync

• switchFirstAsync(onValue, onFailure): Promise<void>

• Executes the appropriate callback based on the state of the . If the state is a success, the onValue callback will be executed. If the state is a failure, the onFailure callback will be executed using the first failure as input.

  Parameters

  • onValue: ((value) => Promise<void>)

    • • (value): Promise<void>

      • Parameters

        • value: TValue

        Returns Promise<void>

  • onFailure: ((failure) => Promise<void>)

    • • (failure): Promise<void>

      • Parameters

        • failure: Failure

        Returns Promise<void>

  Returns Promise<void>

  {Promise}

  Memberof

  FailureOr

Static fromFailure

• fromFailure<TValue>(failure): FailureOr<TValue>

• Type Parameters

  • TValue

  Parameters

  • failure: Failure

  Returns FailureOr<TValue>

Static fromFailures

• fromFailures<TValue>(failures): FailureOr<TValue>

• Type Parameters

  • TValue

  Parameters

  • failures: Failure[]

  Returns FailureOr<TValue>

Static fromValue

• fromValue<TValue>(value): FailureOr<TValue>

• Type Parameters

  • TValue

  Parameters

  • value: TValue

  Returns FailureOr<TValue>