/typescript-maybe

A TypeScript Maybe Type and Module

Primary LanguageTypeScript

TypeScript Maybe Type and Module

Installation

$ npm install --save typescript-maybe

Example Usage

import { Maybe, MaybeType } from 'typescript-maybe'
import { compose, toUpper } from 'ramda'

// An example of an "unsafe" function that may return undefined or null:
function unsafeHead<T> (list: ReadonlyArray<T>): T {
  return list[0]
}

// Elegantly handling this unsafe function in a composition chain:
type UpperCaseHead = (list: ReadonlyArray<string>) => Maybe<string>
const otherUpperCaseHead: UpperCaseHead = compose(
  Maybe.map(toUpper),
  Maybe.of(unsafeHead),
) as UpperCaseHead

// Handling Maybe in a composition chain and returning a default value:
type UpperCaseHeadWithDefault = (list: ReadonlyArray<string>) => string
const upperCaseHeadWithDefault: UpperCaseHead = compose(
  Maybe.withDefault('Something didn’t quite go according to plan!'),
  Maybe.map(toUpper),
  Maybe.of(unsafeHead),
) as UpperCaseHeadWithDefault