mighty-maybe v1.0.1

Mighty Maybe

import { Maybe, maybePipe, mapMaybe } from "mighty-maybe";

const someValue = {}; //...imagine some nested object

const maybeResult: Maybe<number> = maybePipe(someValue,
  x => x.foo,
  y => y.bar,
  z => z * 24
);

const foo: Maybe<number> = undefined;

mapMaybe(foo, x => x * 69);

Installation

npm:

npm install --save mighty-maybe

yarn:

yarn add mighty-maybe

Base types

No classes, only 2 simple types.

type Maybe<T> = T | null | undefined;

export type OperatorMaybeFunction<T, V> = (val: NonNullable<T>) => V;

Functions

Example:

isMaybe(arg: any)

Return true if value is null or undefined.

isMaybe(null); // true
isMaybe(undefined); // true

const arr: number[] = [];
isMaybe(arr.length); // false

maybeFirst<T>(maybes: Maybe<T>[], cb: (val: T) => V): Maybe<V>

Calls callback cb on first non Maybe<T> value from an array of maybes.

maybeFirst([null, null, 32]); // 32

maybeMap<T, V>(maybe: Maybe<V>, cb: (val: V) => V): Maybe<V>

Invoke callback on Maybe returning the value or null

mapMaybe<number, string>(42, x => String(x)); // "42"
mapMaybe<number, string>(undefined, x => String(x)); // null

maybeMapOrElse<T, V>(maybe: Maybe<T>, cb: OperatorMaybeFunction<T, V>) => Maybe<V>

Call function on maybe or fallback to a defined callback

const value: Maybe<number> = 2

maybeMapOrElse(value, val => val * 22, () => 42);

maybePipe<T, ...Y>(maybe: Maybe<T>, ...operations: )

Chain a series of callbacks on a Maybe<T>

const someUntypedObject: Record<string, number> = {};
 *
maybePipe<number>(someObject,
		x => x.foo,
		y => y != 42 ? y : null,
		z => z + 2
);
 *
// Or with the pre-defined operations
 *
const someUntypedObject: Record<string, number> = {};
 *
maybePipe<number>(someObject,
		maybeOpMap(x => x.foo),
		maybeOpFilter(y => y != 42)
		maybeOpMap(z => z + 2)
);

maybeMapAll<...S1, V>(maybes: Maybe<...S1>[], cb: (val: ...S1[]) => V): Maybe<V>

Invoke callback on array of maybes only if all of the maybes are NonNullable. Here the callback function would not get invoked as circle2 is null:

Usage:

type Circle = {
  x: number;
  y: number;
};
const list: Circle[] = [{ x:10, y:2 }, null, {x:20, y: 69}];
maybeMapAll(list, [circle1, circle2, circle3] => {
  // logic...
});