Order

Index

Constructor

• compareBy

Other

• combine
• reverse

Constructor

compareBy

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

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

  @example

  const compareByName = 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 = combine(
    (left: Person, right: Person) => String.compare(left.name, right.name),
    (left: Person, right: Person) => Number.compare(left.age, right.age),
  );

  ---

  Type parameters

  • T

reverse

• reverse<T>(self: Order<T> | Pick<Comparable<T>, compare>): Order<T>

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

  @example

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

  ---

  Type parameters

  • T