unwrapLeft

Unwraps the payload of a Left and returns the input unchanged when the input is not Left.

Interactive example

Syntax

function unwrapLeft<
  GenericInput extends unknown
>(
  input: GenericInput
): GenericInput extends Left
  ? Unwrap<GenericInput>
  : GenericInput

Parameters

• input: Value to unwrap when it is a Left.

Return value

Returns the unwrapped payload for Left, otherwise returns input unchanged.

See also

• unwrapLeftOrThrow – Throwing variant when input is not Left.
• isLeft – Type guard to check left side.
• unwrapByInformation – Information-based non-throwing unwrap.