Skip to main content Link Search Menu Expand Document (external link)

Ordering.ts overview

Since v0.24.0


Exports Grouped by Category


instances

Monoid

Monoid instance for Ordering, returns the left-most non-zero Ordering.

The empty value is 0.

Example

import { Monoid } from "@effect/typeclass/data/Ordering"

console.log(Monoid.combine(Monoid.empty, -1))
// -1
console.log(Monoid.combine(Monoid.empty, 1))
// 1
console.log(Monoid.combine(1, -1))
// 1

Signature

declare const Monoid: monoid.Monoid<Ordering>

Source

Since v0.24.0

Semigroup

Semigroup instance for Ordering, returns the left-most non-zero Ordering.

Example

import { Semigroup } from "@effect/typeclass/data/Ordering"

console.log(Semigroup.combine(0, -1))
// -1
console.log(Semigroup.combine(0, 1))
// 1
console.log(Semigroup.combine(1, -1))
// 1

Signature

declare const Semigroup: semigroup.Semigroup<Ordering>

Source

Since v0.24.0