Maybe-ts
Maybe monad for typescript inspired by elm's Maybe.
Installation:
npm install @nutgaard/maybe-ts --saveExamples
The library exports two different ways of using the Maybe-monad, functional and classical.
NB! Uses different ways of importing the library.
Function:
import Maybe from 'maybe-ts';
Maybe.map((value) => value.toUpperCase(), Maybe.just('Hello, World'));
// If you use a library for `compose`/`flow`/`pipe` or similar concepts. (See ./test/pipe.ts example)
pipe(
Maybe.just('Hello, World'),
Maybe.map((value: string) => value.toUpperCase())
);
// Or, with the use of the pipe-operator
Maybe.just('Hello, World')
|> Maybe.map((value) => value.toUpperCase())Classical:
import { MaybeCls as Maybe } from '../src/maybe-ts';
Maybe.just('Hello, World')
.map((value) => value.toUpperCase())Types
Full documentation of types can be seen here
Credits
Made using the awesome typescript library starter
Index
Type aliases
Just
Type declaration
-
type: JUST
-
value: TYPE
Maybe
Nothing
Type declaration
-
type: NOTHING
Variables
Const curry
Functions
andThen
filter
isJust
-
Parameters
-
maybe: Maybe<any>
Returns boolean
-
isNothing
-
Parameters
-
maybe: Maybe<any>
Returns boolean
-
join
just
-
Type parameters
-
TYPE
Parameters
-
value: TYPE | null | undefined
Returns Maybe<TYPE>
-
map
map2
map3
nothing
-
Returns object
-
type: NOTHING
-
or
toArray
-
Type parameters
-
TYPE
Parameters
-
maybe: Maybe<TYPE>
Returns Array<TYPE>
-
typeMatching
-
Type parameters
-
TYPE
-
RETURN
Parameters
-
ifNothing: function
-
-
Returns RETURN
-
-
-
ifJust: function
-
-
Parameters
-
value: TYPE
Returns RETURN
-
-
-
-
maybe: Maybe<TYPE>
Returns RETURN
-
withDefault
-
Type parameters
-
TYPE
-
OTHER
Parameters
-
defaultValue: OTHER
-
maybe: Maybe<TYPE>
Returns TYPE | OTHER
-
withDefaultLazy
-
Type parameters
-
TYPE
-
OTHER
Parameters
-
defaultValue: function
-
-
Returns OTHER
-
-
-
maybe: Maybe<TYPE>
Returns TYPE | OTHER
-
Object literals
Const NothingValue
type
Generated using TypeDoc