Comp.booleanComp | /common/index.ts | rimbu@1.0.2

Module

x/rimbu/common/index.ts>Comp.booleanComp

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

rimbu-org/rimbu

Go to Latest

mod.ts (default module)

function Comp.booleanComp

import { Comp } from "https://deno.land/x/rimbu@1.0.2/common/index.ts";
const { booleanComp } = Comp;

booleanComp(): Comp<boolean>

Returns a default boolean Comp instance that orders booleans according to false < true.

Examples

Example 1

const c = Comp.booleanComp();
console.log(c.compare(false, true) < 0)
// => true
console.log(c.compare(true, true))
// => 0

Returns

Comp<boolean>