Interface MaybeConstructor

The public interface for the Maybe class as a value: a constructor and the associated static properties.

Hierarchy

  • MaybeConstructor

Constructors

Properties

Constructors

  • Type Parameters

    • T

    Parameters

    • Optional value: null | T
      Optional

    Returns Maybe<T>

Properties

just: (<T>(value?) => Maybe<T>)

Type declaration

    • <T>(value?): Maybe<T>
    • Create an instance of Maybe.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>.

      Type Parameters

      • T

      Parameters

      • Optional value: null | T

        The value to wrap in a Maybe.Just.

        Optional

      Returns Maybe<T>

      An instance of Maybe.Just<T>.

      Typeparam

      T The type of the item contained in the Maybe.

      Throws

      If you pass null or undefined.

nothing: (<T>(_?) => Nothing<T>)

Type declaration

    • <T>(_?): Nothing<T>
    • Create an instance of Maybe.Nothing.

      If you want to create an instance with a specific type, e.g. for use in a function which expects a Maybe<T> where the <T> is known but you have no value to give it, you can use a type parameter:

      const notString = Maybe.nothing<string>();
      

      Type Parameters

      • T

      Parameters

      • Optional _: null
        Optional

      Returns Nothing<T>

      An instance of Maybe.Nothing<T>.

      Typeparam

      T The type of the item contained in the Maybe.

of: (<T>(value) => Maybe<T>)

Type declaration

    • <T>(value): Maybe<T>
    • Create a Maybe from any value.

      To specify that the result should be interpreted as a specific type, you may invoke Maybe.of with an explicit type parameter:

      const foo = Maybe.of<string>(null);
      

      This is usually only important in two cases:

      1. If you are intentionally constructing a Nothing from a known null or undefined value which is untyped.
      2. If you are specifying that the type is more general than the value passed (since TypeScript can define types as literals).

      Type Parameters

      • T

      Parameters

      • value: undefined | null | T

        The value to wrap in a Maybe. If it is undefined or null, the result will be Nothing; otherwise it will be the type of the value passed.

      Returns Maybe<T>

      Typeparam

      T The type of the item contained in the Maybe.

Generated using TypeDoc