API / Js / Null

You are currently looking at the v6.0 - v8.2 docs (Reason v3.6 syntax edition). You can find the latest API docs here.

(These docs cover all versions between v3 to v8 and are equivalent to the old BuckleScript docs before the rebrand)

Null

Provide utilities around null('a).

RE
type t('a) = Js.null('a);

Local alias for Js.null('a).

RE
let return: 'a => t('a);

Constructs a value of Js.null('a) containing a value of 'a.

test

RE
let test: t('a) => bool;

Returns true if the given value is empty (null), false otherwise.

empty

RE
let empty: t('a);

The empty value, null.

getUnsafe

RE
let getUnsafe: t('a) => 'a;

getExn

RE
let getExn: t('a) => 'a;

bind

RE
let bind: (t('a), (. 'a) => 'b) => t('b);

Maps the contained value using the given function. If Js.null('a) contains a value, that value is unwrapped, mapped to a 'b using the given function 'a => 'b, then wrapped back up and returned as Js.null('b).

RE
let maybeGreetWorld = (maybeGreeting: Js.null(string)) => Js.Null.bind(maybeGreeting, [@bs] greeting => greeting ++ " world!");

iter

RE
let iter: (t('a), (. 'a) => unit) => unit;

Iterates over the contained value with the given function. If Js.null('a) contains a value, that value is unwrapped and applied to the given function.

RE
let maybeSay = (maybeMessage: Js.null(string)) => Js.Null.iter(maybeMessage, [@bs] message => Js.log(message));

fromOption

RE
let fromOption: option('a) => t('a);

Maps option('a) to Js.null('a). Some(a) => a None => empty

from_opt

RE
let from_opt: option('a) => t('a);

toOption

RE
let toOption: t('a) => option('a);

Maps Js.null('a) to option('a). a => Some(a) empty => None

to_opt

RE
let to_opt: t('a) => option('a);