Class Success<T>

constructor

• new Success<T>(value: T): Success<T>

  Type Parameters

  • T

  Parameters

  • value: T

  Returns Success<T>

Staticcreate

• create<T>(value: T): Success<T>

  Creates a new Success result.

  Type Parameters

  • T

  Parameters

  • value: T

    The success value

  Returns Success<T>

  A Success instance

  Example

  return Success.create(42);
  Copy

map

• map<U>(fn: (value: T) => U): Success<U>

  Maps the success value to a new value.

  Type Parameters

  • U

  Parameters

  • fn: (value: T) => U

    The mapping function

  Returns Success<U>

  A new Success with the mapped value

  Example

  const result = Success.create(5);
  const doubled = result.map(x => x * 2); // Success(10)
  Copy

flatMap

• flatMap<U, E extends Error>(fn: (value: T) => Result<U, E>): Result<U, E>

  Flat maps the success value to a new Result.

  Type Parameters

  • U
  • E extends Error

  Parameters

  • fn: (value: T) => Result<U, E>

    The flat mapping function

  Returns Result<U, E>

  The result of the flat mapping function

  Example

  const result = Success.create(5);
  const divided = result.flatMap(x => divide(10, x)); // Success(2) or Failure
  Copy

ReadonlyisSuccess

ReadonlyisFailure

Readonlyvalue