Comp.withUndefined | /mod.ts | rimbu@0.13.1

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.

actor base bimap bimultimap collection-types common core deep graph hashed list multimap multiset ordered sorted spy stream table typical

mod.ts (default module)

ArrowGraph

ArrowGraphHashed

ArrowGraphSorted

ArrowValuedGraph

ArrowValuedGraphHashed

ArrowValuedGraphSorted

EdgeValuedGraphHashed

EdgeValuedGraphSorted

HashMultiMapHashValue

HashMultiMapSortedValue

HashMultiSet

HashSet

HashTableHashColumn

HashTableSortedColumn

SortedMultiMapHashValue

SortedMultiMapSortedValue

SortedMultiSet

SortedSet

SortedTableHashColumn

SortedTableSortedColumn

function Comp.withUndefined

import { Comp } from "https://deno.land/x/rimbu@0.13.1/mod.ts";
const { withUndefined } = Comp;

withUndefined<T>(comp: Comp<T>): Comp<T | undefined>

Returns a Comp instance that extends the given comp instance with the capability to handle undefined values, where undefined is considered to be smaller than any other value, and equal to another undefined.

Examples

Example 1

const c = Comp.withUndefined(Comp.numberComp())
console.log(c.compare(undefined, 5) < 0)
// => true
console.log(c.compare(undefined, undefined))
// => 0

Type Parameters

Parameters

comp: Comp<T>

the Comp instance to wrap

Returns

Comp<T | undefined>