ot
option.ts
npm i option.ts
ot

option.ts

Option ~Monad for typescript

by Alexandre Galays

0.3.0 (see all)License:MITTypeScript:Built-In
npm i option.ts
Readme

option.ts

Option ~Monad for typescript

option.ts can be used with either javascript or typescript.
This Option wrapper is mostly meant to be used at call sites, where you want to create and transform optional value expressions. The advantage of only using it there, is that you keep neat, non wrapped JSON structures as your data.

API

Importing the library

Here's everything that can be imported from option.ts:

import { Option, None, Some } from 'option.ts'

Creating an Option

Option(x)

Creates an Option from a value. If the value is null or undefined, it will create a None, else a Some.

const some = Option(33) // some === Some(33)
const none = Option(null) // none === None

If you already know the value is defined for sure (not nullable) or not, you can create a Some or None directly:

const some = Some(33) // Some(null | undefined) wouldn't compile.
const none = None

Option.all(...optionsOrValues)

Creates a new Option holding the tuple of all the passed values if they were all Some or non null/undefined values,
else returns None

const some = Option.all(
  Option(10),
  20,
  Option(5)
)
// some === Some([10, 20, 5])

const none = Option.all(
  Option(10),
  None,
  Option(5),
  null
)
// none === None

None

The Option constant representing no value.

import { None } from 'option.ts'

Transforming an Option

map

Maps the value contained in this Some, else returns None. Depending on the map function return value, a Some could be tranformed into a None, as a Some is guaranteed to never contain a null or undefined value.

const some = Option(33).map(x => x * 2)
// some === Some(66)

flatMap

Maps the value contained in this Some to a new Option, else returns None.

const some = Option(33).flatMap(_ => Option(44))
// some === Some(44)

filter

If this Option is a Some and the predicate returns true, keep that Some. In all other cases, return None.

const some = Option(33).filter(x => x > 32)
// some === Some(33)

orElse

Returns this Option unless it's a None, in which case the provided alternative is returned.

const some = Option(null).orElse(() => Option(33))
// some === Some(33)

match

Returns the result of calling Some(value) if this is a Some, else returns the result of calling `None()``

const some = Option(10)
const result = some.match({
  Some: x  => (x * 2).toString(),
  None: () => 999
})
// result === '20'

Misc

get

Some instances return their value, whereas None always return undefined.
Thus, this method never throws.

const value = Some(33).get()
// value === 33

isDefined

Returns whether this Option has a defined value (i.e, it's a Some(value))
Note: this refines the type of the Option to be a Some so it's guaranteed its value is not null/undefined.

getOrElse

Returns this Option's value if it's a Some, else return the provided alternative

const value = Option(undefined).getOrElse(33)

// value === 33

forEach

Applies the given procedure to the option's value, if it is non empty.

Option(33).forEach(x => console.log(x))

Downloads/wk

64

GitHub Stars

15

LAST COMMIT

NaNyrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

1

OPEN PRs

0
VersionTagPublished
0.3.0
latest
6yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate