Class SyntaxAbstract

constructor

• new Syntax(): Maybe.Syntax

• Returns Maybe.Syntax

Readonly Abstract kind

[cmb]

• [cmb]<T>(this, that): Maybe<T>

• If this and that Maybe are Just, combine their values; otherwise, return the first Maybe that is not Nothing.

  Type Parameters

  • T extends Semigroup<T>

  Parameters

  • this: Maybe<T>

  • that: Maybe<T>

  Returns Maybe<T>

[cmp]

• [cmp]<T>(this, that): Ordering

• Compare this and that Maybe to determine their ordering.

  Type Parameters

  • T extends Ord<T>

  Parameters

  • this: Maybe<T>

  • that: Maybe<T>

  Returns Ordering

  Remarks

  When ordered, Nothing always compares as less than Just. If both are Just, their values are compared to determine the ordering.

[eq]

• [eq]<T>(this, that): boolean

• Compare this and that Maybe to determine their equality.

  Type Parameters

  • T extends Eq<T>

  Parameters

  • this: Maybe<T>

  • that: Maybe<T>

  Returns boolean

  Remarks

  Two Maybe are equal if they are both Nothing, or they are both both Just and their values are equal.

and

• and<T1>(this, that): Maybe<T1>

• If this Maybe is Just, ignore its value and return that Maybe.

  Type Parameters

  • T1

  Parameters

  • this: Maybe<any>

  • that: Maybe<T1>

  Returns Maybe<T1>

andThen

• andThen<T, T1>(this, f): Maybe<T1>

• If this Maybe is Just, apply a function to its value to return another Maybe.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: ((val) => Maybe<T1>)

    • • (val): Maybe<T1>

      • Parameters

        • val: T

        Returns Maybe<T1>

  Returns Maybe<T1>

andThenGo

• andThenGo<T, T1>(this, f): Maybe<T1>

• If this Maybe is Just, apply a generator function to its value to its value to return another Maybe.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: ((val) => Maybe.Go<T1>)

    • • (val): Maybe.Go<T1>

      • Parameters

        • val: T

        Returns Maybe.Go<T1>

  Returns Maybe<T1>

filter

• filter<T, T1>(this, f): Maybe<T1>

• If this Maybe is Just, apply a predicate to filter its value.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: ((val) => val is T1)

    • • (val): val is T1

      • Parameters

        • val: T

        Returns val is T1

  Returns Maybe<T1>

  Remarks

  If the predicate returns false, return Nothing.

• filter<T>(this, f): Maybe<T>

• Type Parameters

  • T

  Parameters

  • this: Maybe<T>

  • f: ((val) => boolean)

    • • (val): boolean

      • Parameters

        • val: T

        Returns boolean

  Returns Maybe<T>

getOr

• getOr<T, T1>(this, fallback): T | T1

• If this Maybe is Just, extract its value; otherwise, return a fallback value.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • fallback: T1

  Returns T | T1

getOrElse

• getOrElse<T, T1>(this, f): T | T1

• If this Maybe is Just, extract its value; otherwise, invoke a function to return a fallback value.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: (() => T1)

    • • (): T1

      • Returns T1

  Returns T | T1

isJust

• isJust<T>(this): this is Just<T>

• Test whether this Maybe is Just.

  Type Parameters

  • T

  Parameters

  • this: Maybe<T>

  Returns this is Just<T>

isNothing

• isNothing(this): this is Nothing

• Test whether this Maybe is Nothing.

  Parameters

  • this: Maybe<any>

  Returns this is Nothing

map

• map<T, T1>(this, f): Maybe<T1>

• If this Maybe is Just, apply a function to map its value.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: ((val) => T1)

    • • (val): T1

      • Parameters

        • val: T

        Returns T1

  Returns Maybe<T1>

mapNullish

• mapNullish<T, T1>(this, f): Maybe<T1>

• If this Maybe is Just, apply a partial function to map its value.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: ((val) => undefined | null | T1)

    • • (val): undefined | null | T1

      • Parameters

        • val: T

        Returns undefined | null | T1

  Returns Maybe<T1>

  Remarks

  If the function returns null or undefined, return Nothing.

or

• or<T, T1>(this, that): Maybe<T | T1>

• If this Maybe is Nothing, return that Maybe.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • that: Maybe<T1>

  Returns Maybe<T | T1>

orElse

• orElse<T, T1>(this, f): Maybe<T | T1>

• If this Maybe is Nothing, invoke a function to return a fallback Maybe.

  Type Parameters

  • T

  • T1

  Parameters

  • this: Maybe<T>

  • f: (() => Maybe<T1>)

    • • (): Maybe<T1>

      • Returns Maybe<T1>

  Returns Maybe<T | T1>

toNullish

• toNullish<T>(this): undefined | T

• If this Maybe is Just, extract its value; otherwise, return undefined.

  Type Parameters

  • T

  Parameters

  • this: Maybe<T>

  Returns undefined | T

unwrap

• unwrap<T, T1, T2>(this, ifNothing, unwrapJust): T1 | T2

• If this Maybe is Just, apply a function to extract its value; otherwise, invoke a function to return a fallback value.

  Type Parameters

  • T

  • T1

  • T2

  Parameters

  • this: Maybe<T>

  • ifNothing: (() => T1)

    • • (): T1

      • Returns T1

  • unwrapJust: ((val) => T2)

    • • (val): T2

      • Parameters

        • val: T

        Returns T2

  Returns T1 | T2

zipWith

• zipWith<T, T1, T2>(this, that, f): Maybe<T2>

• If this and that Maybe are Just, apply a function to combine their values.

  Type Parameters

  • T

  • T1

  • T2

  Parameters

  • this: Maybe<T>

  • that: Maybe<T1>

  • f: ((lhs, rhs) => T2)

    • • (lhs, rhs): T2

      • Parameters

        • lhs: T

        • rhs: T1

        Returns T2

  Returns Maybe<T2>