Bounded API Reference

Constructors

Added in v0.24.0 Source

Monoid that returns last maximum of elements.

declare function max<A>(B: Bounded<A>): Monoid<A>

Added in v0.24.0 Source

Monoid that returns last minimum of elements.

declare function min<A>(B: Bounded<A>): Monoid<A>

Added in v0.24.0 Source

Checks if a value is between the lower and upper limit of a bound.

declare function between<A>(B: Bounded<A>): (a: A) => boolean

Added in v0.24.0 Source

interface Bounded<A> {
  readonly compare: Order<A>;
  readonly maxBound: A;
  readonly minBound: A;
}

Added in v0.24.0 Source

interface BoundedTypeLambda extends TypeLambda {
  readonly type: Bounded<unknown>;
}

Added in v0.24.0 Source

Clamp a value between minBound and maxBound values.

declare function clamp<A>(B: Bounded<A>): (a: A) => A

Added in v0.24.0 Source

Reverses the Order of a Bounded and flips maxBound and minBound values.

declare function reverse<A>(B: Bounded<A>): Bounded<A>