Skip to content

failureResult ​

failureResult ​

Builds a flattened failure result in one step.

Single source of truth for the { ok: false, error, code, message } shape: modules should construct failures with this instead of hand-rolling the object literal. The error payload carries the redundant ok: false discriminant so it matches the per-operation *Failure interfaces (interface XFailure extends Micro509Error<…> { ok: false }).

ts
function failureResult<TCode extends string, TDetails>(
	code: TCode,
	message: string,
	details?: TDetails,
): ErrorResult<TCode, TDetails, Micro509Error<TCode, TDetails> & {
  readonly ok: false
}>

Parameters

  • code: TCode
  • message: string
  • details?: TDetails

Released under the MIT License.