unwrapRight

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

Interactive example

Syntax

function unwrapRight<
  GenericInput extends unknown
>(
  input: GenericInput
): GenericInput extends Right
  ? Unwrap<GenericInput>
  : GenericInput

Parameters

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

Return value

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

See also

• unwrapRightOrThrow – Throwing variant when input is not Right.
• isRight – Type guard to check right side.
• unwrapByInformation – Information-based non-throwing unwrap.