nochoices/src/flatten.ts

Full featured implementation of options into typescript.

import {Option} from "./option.js"

/**
 * Flattens nested options in one level. This function
 * is similar to {@link Option.flatten} but more typesafe.
 *
 * Using this function is possible to ensure at compile time that the
 * target is optional is actually a nested optional.
 *
 * @typeParam T - Any type
 * @param opt - Optional to flatten
 * @returns Flattened option
 *
 * @example
 * ```ts
 * const opt1 = Option.Some(Option.Some(10))
 * flatten(opt1).unwrap() // 10
 *
 * const opt2: Option<Option<string>> = Option.None()
 * const flatten2: Option<string>= flatten(opt2)
 * flatten2.isNone() // true
 * ```
 */
export function flatten<T>(opt: Option<Option<T>>): Option<T> {
  return opt.unwrapOr(Option.None())
}