Class Ok<TValue, TError>

constructor

• new Ok<TValue, TError>(value: TValue): Ok<TValue, TError>

• Type Parameters

  • TValue
  • TError

  Parameters

  • value: TValue

  Returns Ok<TValue, TError>

Readonlyvalue

doOnOk

• doOnOk(handler: (value: TValue) => void): Result<TValue, TError>

• Runs the handler method an return the same an unaltered copy of the Result. It could be used to log an output when the result is Ok without breaking the flow

  Parameters

  • handler: (value: TValue) => void

    method to be run when the result is Ok

  Returns Result<TValue, TError>

  a copy of the same Result

isErr

• isErr(): this is Err<TValue, TError>

• Check if a Result is an Err inferring its type. !isErr() should be used before accessing the value

  Returns this is Err<TValue, TError>

  false as the Resul is OK

map

• map<TMappedValue>(
      mapper: (value: TValue) => TMappedValue,
  ): Result<TMappedValue, TError>

• Maps the value to another one with a different type. It leaves the Error type unaltered

  Type Parameters

  • TMappedValue

  Parameters

  • mapper: (value: TValue) => TMappedValue

    The mapper method to apply an OK value

  Returns Result<TMappedValue, TError>

  a new result with the new mapped value

mapError

• mapError<TMappedError>(
      _mapper: (error: TError) => TMappedError,
  ): Result<TValue, TMappedError>

• Maps the error type to another one. It leaves the Ok type and value unaltered

  Type Parameters

  • TMappedError

  Parameters

  • _mapper: (error: TError) => TMappedError

    This mapper method is not used for an Ok value

  Returns Result<TValue, TMappedError>

  a new result with the new mapped error type and an value

valueOrAbort

• valueOrAbort(): TValue

• Throws an abort error if the result doesn't represent a value.

  Returns TValue

valueOrBug

• valueOrBug(): TValue

• A safe mode to throw the error of the Result

  Returns TValue