Function just

Create a Maybe instance which is a Just.

null and undefined are allowed by the type signature so that the function may throw on those rather than constructing a type like Maybe<undefined>.

Template: T

The type of the item contained in the Maybe.

Param: value

The value to wrap in a Maybe.Just.

Returns

An instance of Maybe.Just<T>.

Throws

If you pass null or undefined.

  • just<F extends (...args: any) => {}>(value: F): Maybe<F>

  • Create an instance of Maybe.Just.

    Type Parameters

    • F extends (...args: any) => {}

    Parameters

    • value: F

      The value to wrap in a Maybe.Just.

    Returns Maybe<F>

    An instance of Maybe.Just<T>.

    Throws

    If you pass null or undefined.

  • just<T extends {}, F extends (...args: any) => undefined | null | T>(
        value: F,
    ): never

  • Create an instance of Maybe.Just.

    Type Parameters

    • T extends {}

      The type of the item contained in the Maybe.

    • F extends (...args: any) => undefined | null | T

    Parameters

    • value: F

      The value to wrap in a Maybe.Just.

    Returns never

    An instance of Maybe.Just<T>.

    Throws

    If you pass null or undefined.

  • just<F extends (...args: any) => undefined | null>(value: F): never

  • Create an instance of Maybe.Just.

    Type Parameters

    • F extends (...args: any) => undefined | null

    Parameters

    • value: F

      The value to wrap in a Maybe.Just.

    Returns never

    An instance of Maybe.Just<T>.

    Throws

    If you pass null or undefined.

  • just<T extends {}>(value: T): Maybe<T>

  • Create an instance of Maybe.Just.

    Type Parameters

    • T extends {}

      The type of the item contained in the Maybe.

    Parameters

    • value: T

      The value to wrap in a Maybe.Just.

    Returns Maybe<T>

    An instance of Maybe.Just<T>.

    Throws

    If you pass null or undefined.

Settings

Member Visibility