fp-ts

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Overview

The Ord type class represents types which support comparisons with a total order.

Instances should satisfy the laws of total orderings:

  1. Reflexivity: S.compare(a, a) <= 0
  2. Antisymmetry: if S.compare(a, b) <= 0 and S.compare(b, a) <= 0 then a <-> b
  3. Transitivity: if S.compare(a, b) <= 0 and S.compare(b, c) <= 0 then S.compare(a, c) <= 0

See Getting started with fp-ts: Ord

Table of contents

Ord (interface)

Signature

export interface Ord<A> extends Setoid<A> {
  readonly compare: (x: A, y: A) => Ordering
}

Added in v1.0.0

ordBoolean (constant)

Signature

export const ordBoolean: Ord<boolean> = ...

Added in v1.0.0

ordDate (constant)

Signature

export const ordDate: Ord<Date> = ...

Added in v1.4.0

ordNumber (constant)

Signature

export const ordNumber: Ord<number> = ...

Added in v1.0.0

ordString (constant)

Signature

export const ordString: Ord<string> = ...

Added in v1.0.0

between (function)

Test whether a value is between a minimum and a maximum (inclusive)

Signature

export const between = <A>(O: Ord<A>): ((low: A, hi: A) => (x: A) => boolean) => ...

Added in v1.0.0

clamp (function)

Clamp a value between a minimum and a maximum

Signature

export const clamp = <A>(O: Ord<A>): ((low: A, hi: A) => (x: A) => A) => ...

Added in v1.0.0

contramap (function)

Signature

export const contramap = <A, B>(f: (b: B) => A, fa: Ord<A>): Ord<B> => ...

Added in v1.0.0

fromCompare (function)

Signature

export const fromCompare = <A>(compare: (x: A, y: A) => Ordering): Ord<A> => ...

Added in v1.0.0

getDualOrd (function)

Signature

export const getDualOrd = <A>(O: Ord<A>): Ord<A> => ...

Added in v1.3.0

getProductOrd (function)

Use getTupleOrd instead

Signature

export const getProductOrd = <A, B>(OA: Ord<A>, OB: Ord<B>): Ord<[A, B]> => ...

Added in v1.0.0

getSemigroup (function)

Signature

export const getSemigroup = <A = never>(): Semigroup<Ord<A>> => ...

Added in v1.0.0

getTupleOrd (function)

Signature

export const getTupleOrd = <A, B>(OA: Ord<A>, OB: Ord<B>): Ord<[A, B]> => ...

Added in v1.14.3

greaterThan (function)

Test whether one value is strictly greater than another

Signature

export const greaterThan = <A>(O: Ord<A>) => (x: A, y: A): boolean => ...

Added in v1.0.0

greaterThanOrEq (function)

Test whether one value is non-strictly greater than another

Signature

export const greaterThanOrEq = <A>(O: Ord<A>) => (x: A, y: A): boolean => ...

Added in v1.0.0

lessThan (function)

Test whether one value is strictly less than another

Signature

export const lessThan = <A>(O: Ord<A>) => (x: A, y: A): boolean => ...

Added in v1.0.0

lessThanOrEq (function)

Test whether one value is non-strictly less than another

Signature

export const lessThanOrEq = <A>(O: Ord<A>) => (x: A, y: A): boolean => ...

Added in v1.0.0

max (function)

Take the maximum of two values. If they are considered equal, the first argument is chosen

Signature

export const max = <A>(O: Ord<A>) => (x: A, y: A): A => ...

Added in v1.0.0

min (function)

Take the minimum of two values. If they are considered equal, the first argument is chosen

Signature

export const min = <A>(O: Ord<A>) => (x: A, y: A): A => ...

Added in v1.0.0

unsafeCompare (function)

Signature

export const unsafeCompare = (x: any, y: any): Ordering => ...

Added in v1.0.0