Variable Option

Type Declaration

• • <T extends unknown>(value: T | null | undefined): Option<T>

  • Safely wraps a value that might be null or undefined in an Option. Creates Some if the value is defined, None otherwise.

    Type Parameters

    • T extends unknown

      The type of the value

    Parameters

    • value: T | null | undefined

      The value to wrap (might be null/undefined)

    Returns Option<T>

    Some(value) if value is defined, None otherwise

• from: <T>(value: T) => Option<T>

  Creates an Option from any value. Alias for Option function.

• fromBinary: <T>(binary: string) => Option<T>

  Creates an Option from binary string

• fromJSON: <T>(json: string) => Option<T>

  Creates an Option from JSON string

• fromYAML: <T>(yaml: string) => Option<T>

  Creates an Option from YAML string

• isNone: <T>(
      option: Option<T>,
  ) => option is Option<T> & { isEmpty: true; value: undefined }

  Type guard to check if an Option is None

• isSome: <T>(option: Option<T>) => option is Option<T> & { isEmpty: false; value: T }

  Type guard to check if an Option is Some

• none: <T>() => Option<T>

  Returns a None instance. Alias for None function.

• sequence: <T extends unknown>(options: Option<T>[]) => Option<T[]>

  Combines an array of Options into a single Option containing an array. Short-circuits on the first None.

• traverse: <T extends unknown, U extends unknown>(
      arr: readonly T[],
      f: (value: T, index: number) => Option<U>,
  ) => Option<U[]>

  Maps an array through a function returning Option, then sequences the results. Short-circuits on the first None — f is not invoked for elements after the first None result.