whenIsOptionalFilled

Applies a callback only when the optional Either contains a value (OptionalFilled).

Interactive example

Syntax

Classic signature

function whenIsOptionalFilled<
  const GenericInput extends unknown,
  const GenericOutput extends AnyValue | EscapeVoid
>(
  input: GenericInput,
  theFunction: (value: Unwrap<Extract<ToEither<GenericInput>, EitherOptionalFilled>>) => GenericOutput
): GenericOutput | Exclude<ToEither<GenericInput>, EitherOptionalFilled>;

Curried signature

function whenIsOptionalFilled<
  const GenericInput extends unknown,
  const GenericOutput extends AnyValue | EscapeVoid
>(
  theFunction: (value: Unwrap<Extract<ToEither<GenericInput>, EitherOptionalFilled>>) => GenericOutput
): (input: GenericInput) => GenericOutput | Exclude<ToEither<GenericInput>, EitherOptionalFilled>;

Parameters

• theFunction: Callback executed when the value is defined.
• input: Value/Either to process.

Return value

Result of the callback or the original value if the optional was empty.

See also

• whenIsOptionalEmpty.
• optional.