Class Failure<E>

constructor

• new Failure<E extends Error>(error: E): Failure<E>

  Type Parameters

  • E extends Error

  Parameters

  • error: E

  Returns Failure<E>

Staticcreate

• create<E extends Error>(error: E): Failure<E>

  Creates a new Failure result.

  Type Parameters

  • E extends Error

  Parameters

  • error: E

    The error

  Returns Failure<E>

  A Failure instance

  Example

  return Failure.create(new DomainError('INVALID_INPUT', 'Input is invalid'));
  Copy

map

• map<U>(_fn: (value: never) => U): Failure<E>

  Maps have no effect on Failure, but preserves the type signature.

  Type Parameters

  • U

  Parameters

  • _fn: (value: never) => U

  Returns Failure<E>

  This Failure instance

  Example

  const result = Failure.create(new Error('fail'));
  const mapped = result.map(x => x * 2); // Still Failure('fail')
  Copy

flatMap

• flatMap<U, E2 extends Error>(_fn: (value: never) => Result<U, E2>): Failure<E>

  Flat map has no effect on Failure, but preserves the type signature.

  Type Parameters

  • U
  • E2 extends Error

  Parameters

  • _fn: (value: never) => Result<U, E2>

  Returns Failure<E>

  This Failure instance cast to the new Result type

  Example

  const result = Failure.create(new Error('fail'));
  const flatMapped = result.flatMap(x => Success.create(x * 2)); // Still Failure('fail')
  Copy

ReadonlyisSuccess

ReadonlyisFailure

Readonlyerror