Order25

Constructors

alwaysEqualfunctionCreates an Order that considers all values as equal.makefunctionCreates a new Order instance from a comparison function.makeReducerfunctionCreates a Reducer for combining Order instances, useful for aggregating orders in collections.

Combinators

flipfunctionCreates a new Order that reverses the comparison order of the input Order.StructfunctionCreates an Order for structs by applying the given Orders to each property in sequence.TuplefunctionCreates an Order for a tuple type based on orders for each element.

Mapping

mapInputconstTransforms an Order on type A into an Order on type B by providing a function that maps values of type B to values of type A.

Combining

combineconstCombines two Order instances to create a new Order that first compares using the first Order, and if the values are equal, then compares using the second Order.combineAllfunctionCombines all Order instances in the provided collection into a single Order.

Comparisons

clampconstRestricts a value between a minimum and a maximum according to the given order.maxconstReturns the maximum of two values according to the given order.minconstReturns the minimum of two values according to the given order.

Instances

BigIntconstOrder instance for bigints that compares them numerically.BooleanconstOrder instance for booleans where false is considered less than true.DateconstOrder instance for Date objects that compares them chronologically by their timestamp.NumberconstOrder instance for numbers that compares them numerically.StringconstOrder instance for strings that compares them lexicographically using JavaScript's < operator.

Predicates

isBetweenconstChecks whether a value is between a minimum and a maximum (inclusive) according to the given order.isGreaterThanconstChecks whether one value is strictly greater than another according to the given order.isGreaterThanOrEqualToconstChecks whether one value is greater than or equal to another according to the given order.isLessThanconstChecks whether one value is strictly less than another according to the given order.isLessThanOrEqualToconstChecks whether one value is less than or equal to another according to the given order.

Type Class

OrderinterfaceRepresents a total ordering for values of type A.

Type Lambdas

OrderTypeLambdainterfaceType lambda for the Order type class, used internally for higher-kinded type operations.

Functions & Values

Arrayfunction