Function maybe

  • Coerces nullish values to undefined.

    Type Parameters

    • T

    Parameters

    • value: T

      The value to coerce.

    Returns T & {} | undefined

    undefined if the value is null or undefined, else the value itself.

    Example

    Basic Usage

    maybe(1) // 1
    maybe(null) // undefined
    maybe(undefined) // undefined

    The returned value will have null removed from its type.

    const maybeStr: string | null
    maybe(maybeStr) // type: string | undefined

    const maybeNum: number | null | undefined
    maybe(maybeNum) // type: number | undefined

Generated using TypeDoc