Comp.createValueOfComp | /common/internal.ts | rimbu@1.0.0

Module

x/rimbu/common/internal.ts>Comp.createValueOfComp

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.createValueOfComp

import { Comp } from "https://deno.land/x/rimbu@1.0.0/common/internal.ts";
const { createValueOfComp } = Comp;

createValueOfComp<T extends { valueOf(): V; }, V>(cls: { new (): T; }, valueComp?: Comp<V>): Comp<T>

Returns a Comp instance that orders objects with a valueOf method according to the given valueComp instance for the valueOf values.

Type Parameters

T extends { valueOf(): V; }

Parameters

cls: { new (): T; }

the constructor of the values the Comp instance can compare

optional

valueComp: Comp<V> = [UNSUPPORTED]

(optional) the Comp instance to use on the .valueOf values

Returns

Comp<T>