Interface None<A>

Type Parameters

  • A

Hierarchy

  • default<A>
    • None

Properties

defined: false

Methods

  • Returns Iterator<A, any, undefined>

  • Apply partial pattern match on optional value

    Type Parameters

    • B

    Parameters

    • collector: ((value) => undefined)
        • (value): undefined
        • Parameters

          • value: A

          Returns undefined

    Returns Option<A>

  • Type Parameters

    • B

    Parameters

    • collector: ((value) => any)
        • (value): any
        • Parameters

          • value: A

          Returns any

    Returns Option<A>

  • Type Parameters

    • B

    Parameters

    • collector: ((value) => B)
        • (value): B
        • Parameters

          • value: A

          Returns B

    Returns Option<B>

  • Type Parameters

    • B

    Parameters

    • collector: ((value) => B)
        • (value): B
        • Parameters

          • value: A

          Returns B

    Returns Option<B>

  • Checks if value equals optional value, or false if empty

    Type Parameters

    • B

    Parameters

    • element: B

    Returns boolean

  • Apply predicate on optional value, or false if empty

    Parameters

    • predicate: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: A

          Returns boolean

    Returns boolean

  • An optional value satisfies predicate

    Parameters

    • filter: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: A

          Returns boolean

    Returns Option<A>

  • An optional value doesn't satisfy predicate

    Parameters

    • filter: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: A

          Returns boolean

    Returns Option<A>

  • Same as map but function must return an optional value

    Type Parameters

    • B

    Parameters

    Returns Option<B>

  • Apply function on optional value, return default if empty

    Type Parameters

    • B

    Parameters

    • fallback: B
    • folder: ((value) => B)
        • (value): B
        • Parameters

          • value: A

          Returns B

    Returns B

  • Apply predicate on optional value, or true if empty

    Parameters

    • predicate: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: A

          Returns boolean

    Returns boolean

  • Apply a procedure on option value

    Parameters

    • consumer: ((value) => void)
        • (value): void
        • Parameters

          • value: A

          Returns void

    Returns void

  • Return value, throw exception if empty

    Returns A

  • Evaluate and return alternate value if empty

    Parameters

    • alternative: A

    Returns A

  • Throws a custom object if option is empty.

    Type Parameters

    • B

    Parameters

    • willThrow: B

    Returns A

  • Apply a function on the optional value

    Type Parameters

    • B

    Parameters

    • map: ((value) => B)
        • (value): B
        • Parameters

          • value: A

          Returns B

    Returns Option<B>

  • Unary list of optional value, otherwise the empty list

    Returns A[]

  • Split an optional pair to two optional values

    Returns A extends [any, any]
        ? [Option<A[0]>, Option<A[1]>]
        : never

  • Split an optional triple to three optional values

    Returns A extends [any, any, any]
        ? [Option<A[0]>, Option<A[1]>, Option<A[2]>]
        : never

  • Combine two optional values to make a paired optional value

    Type Parameters

    • B

    Parameters

    Returns Option<[A, B]>

Generated using TypeDoc