Interface NoneOption<T>

type

isNone

• isNone(): this is NoneOption<T>

• Determines if the Option is None.

  Returns this is NoneOption<T>

  true if the Option is None, otherwise false.

  Example

  console.log(Some(5).isNone()); // false
  console.log(None.isNone()); // true
  Copy

isSome

• isSome(): this is SomeOption<T>

• Determines if the Option is a Some.

  Returns this is SomeOption<T>

  true if the Option is Some, otherwise false.

  Example

  console.log(Some(5).isSome()); // true
  console.log(None.isSome()); // false
  Copy

match

• match<U>(fn): U

• Performs a match operation on the Option, allowing for branching logic based on its state. This method takes an object with functions for each case (Some or None) and executes the corresponding function based on the Option's state, returning the result.

  Type Parameters

  • U extends NonUndefined

  Parameters

  • fn: Match<T, U>

    An object containing two properties: some and none, which are functions to handle the Some and None cases, respectively.

  Returns U

  The result of applying the corresponding function based on the Option's state.

  Example

  const optionSome = Some(5);
  const matchResultSome = optionSome.match({
    some: (value) => `The value is ${value}.`,
    none: () => 'There is no value.',
  });
  console.log(matchResultSome); // Outputs: "The value is 5."
  
  const optionNone = None;
  const matchResultNone = optionNone.match({
    some: (value) => `The value is ${value}.`,
    none: () => 'There is no value.',
  });
  console.log(matchResultNone); // Outputs: "There is no value."
  Copy

unwrapOr

• unwrapOr(def): T

• Returns the contained value if Some, otherwise returns the provided default value.

  Parameters

  • def: T

    The default value to return if the Option is None.

  Returns T

  The contained value if Some, otherwise def.

  Examples

  const someValue = Some("value").unwrapOr("default"); // "value"
  const noneValue = None.unwrapOr("default"); // "default"
  Copy