Order

Index

Constructor

• compareBy

Other

• combine
• primitive
• reverse

Constructor

compareBy

• compareBy<From, To>(selector: (from: To) => From, compareTo: OrderLike<From>): Order<To>

• Return a new Order function that will map the parameters using selectFn

  @example

  const compareByName = Order.compareBy((named: { name: string }) => named.name, String.compare);

  ---

  Type parameters

  • From
  • To

Other

combine

• combine<T>(self: Order<T>, ...others: Order<T>[]): Order<T>

• @example

  interface Person {
    name: string;
    age: number;
  }
  const comparePerson = Order.combine<Person>(
    // 1. Compare by name (ascending)
    Order.compareBy((person) => person.name, String.compare),
    // 2. Compare by age (ascending)
    Order.compareBy((person) => person.age, Number.compare),
  );

  ---

  Type parameters

  • T

primitive

• primitive(left: boolean, right: boolean): Ordering
• primitive(left: bigint, right: bigint): Ordering
• primitive(left: number, right: number): Ordering
• primitive(left: string, right: string): Ordering

• An order function for Primitive values (i.e. boolean, bigint, number, string)

  @example

  [1, 3, 2].toSorted(Order.primitive); // [1, 2, 3]
  ['a', 'c', 'b'].toSorted(Order.primitive); // ['a', 'b', 'c']

reverse

• reverse<T>(self: OrderLike<T>): Order<T>

• Returns a reversed Order from the given Order or Comparable.

  @example

  Order.reverse(Number.compare); // == (left, right) => Ordering.reverse(Number.compare(left, right))
  Order.reverse(Number); // == reverse(Number.compare)

  ---

  Type parameters

  • T