maybe

Classes

Nothing
module:maybe.Nothing

Methods

static isJust(x) → {boolean}
maybe/Just.js, line 10

Checks for Just.

Parameters:
Name Type Description
x *
Returns:
boolean

static isMaybe(x) → {boolean}
maybe/Maybe.js, line 57

Checks for maybe.

Parameters:
Name Type Description
x *

.
Returns:
boolean

static just(x) → {Just}
maybe/Just.js, line 18

Functional constructor (function that returns an instance) for Just - Same as new Just(...) (just shorter and can be used as a function).

Parameters:
Name Type Description
x Just | *
Returns:
Just

static maybe(replacement, fn, maybeInst) → {*}
maybe/Maybe.js, line 19

The maybe function takes a replacement value, a function (unary operation), and a Maybe value. If the Maybe value is Nothing, the function returns the replacement value. Otherwise, it applies the function to the value contained by the Just and returns the result.

Parameters:
Name Type Description
replacement *
fn function

Unary operation.
maybeInst Nothing | Just | *

Maybe instance or non-maybe value.
Returns:
*

static maybeEqual(a, b) → {boolean}
maybe/Maybe.js, line 48

Equality operator for maybes.

Parameters:
Name Type Description
a *

Maybe 1.
b *

Maybe 2.
Returns:
boolean

static nothing() → {Nothing}
maybe/Nothing.js, line 35

Returns Nothing.

Returns:
Nothing

static toJust(x) → {Just}
maybe/Just.js, line 27

Ensures Just

Parameters:
Name Type Description
x Just | *
Returns:
Just

static toMaybe(x) → {Maybe}
maybe/Maybe.js, line 65

Creates maybe from value.

Parameters:
Name Type Description
x *
Returns:
Maybe -
  • Just or Nothing based on value.

static unWrapJust(x) → {*}
maybe/Maybe.js, line 32

Unwraps just (recursively).

Parameters:
Name Type Description
x *

Expected Just.
Returns:
*

static unWrapMaybe(x) → {*}
maybe/Maybe.js, line 40

Unwraps maybe (recursively).

Parameters:
Name Type Description
x *

Expected Maybe.
Returns:
*