MAINHACK

Viewing / Editing File: Ordering.d.ts

/**
 * @since 2.0.0
 */
import type { LazyArg } from "./Function.js";
/**
 * @category model
 * @since 2.0.0
 */
export type Ordering = -1 | 0 | 1;
/**
 * Inverts the ordering of the input `Ordering`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { reverse } from "effect/Ordering"
 *
 * assert.deepStrictEqual(reverse(1), -1)
 * assert.deepStrictEqual(reverse(-1), 1)
 * assert.deepStrictEqual(reverse(0), 0)
 * ```
 *
 * @since 2.0.0
 */
export declare const reverse: (o: Ordering) => Ordering;
/**
 * Depending on the `Ordering` parameter given to it, returns a value produced by one of the 3 functions provided as parameters.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { Ordering } from "effect"
 * import { constant } from "effect/Function"
 *
 * const toMessage = Ordering.match({
 *   onLessThan: constant('less than'),
 *   onEqual: constant('equal'),
 *   onGreaterThan: constant('greater than')
 * })
 *
 * assert.deepStrictEqual(toMessage(-1), "less than")
 * assert.deepStrictEqual(toMessage(0), "equal")
 * assert.deepStrictEqual(toMessage(1), "greater than")
 * ```
 *
 * @category pattern matching
 * @since 2.0.0
 */
export declare const match: {
    /**
     * Depending on the `Ordering` parameter given to it, returns a value produced by one of the 3 functions provided as parameters.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { Ordering } from "effect"
     * import { constant } from "effect/Function"
     *
     * const toMessage = Ordering.match({
     *   onLessThan: constant('less than'),
     *   onEqual: constant('equal'),
     *   onGreaterThan: constant('greater than')
     * })
     *
     * assert.deepStrictEqual(toMessage(-1), "less than")
     * assert.deepStrictEqual(toMessage(0), "equal")
     * assert.deepStrictEqual(toMessage(1), "greater than")
     * ```
     *
     * @category pattern matching
     * @since 2.0.0
     */
    <A, B, C = B>(options: {
        readonly onLessThan: LazyArg<A>;
        readonly onEqual: LazyArg<B>;
        readonly onGreaterThan: LazyArg<C>;
    }): (self: Ordering) => A | B | C;
    /**
     * Depending on the `Ordering` parameter given to it, returns a value produced by one of the 3 functions provided as parameters.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { Ordering } from "effect"
     * import { constant } from "effect/Function"
     *
     * const toMessage = Ordering.match({
     *   onLessThan: constant('less than'),
     *   onEqual: constant('equal'),
     *   onGreaterThan: constant('greater than')
     * })
     *
     * assert.deepStrictEqual(toMessage(-1), "less than")
     * assert.deepStrictEqual(toMessage(0), "equal")
     * assert.deepStrictEqual(toMessage(1), "greater than")
     * ```
     *
     * @category pattern matching
     * @since 2.0.0
     */
    <A, B, C = B>(o: Ordering, options: {
        readonly onLessThan: LazyArg<A>;
        readonly onEqual: LazyArg<B>;
        readonly onGreaterThan: LazyArg<C>;
    }): A | B | C;
};
/**
 * @category combining
 * @since 2.0.0
 */
export declare const combine: {
    /**
     * @category combining
     * @since 2.0.0
     */
    (that: Ordering): (self: Ordering) => Ordering;
    /**
     * @category combining
     * @since 2.0.0
     */
    (self: Ordering, that: Ordering): Ordering;
};
/**
 * @category combining
 * @since 2.0.0
 */
export declare const combineMany: {
    /**
     * @category combining
     * @since 2.0.0
     */
    (collection: Iterable<Ordering>): (self: Ordering) => Ordering;
    /**
     * @category combining
     * @since 2.0.0
     */
    (self: Ordering, collection: Iterable<Ordering>): Ordering;
};
/**
 * @category combining
 * @since 2.0.0
 */
export declare const combineAll: (collection: Iterable<Ordering>) => Ordering;
//# sourceMappingURL=Ordering.d.ts.map

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: Ordering.d.ts

Server Info

System Features

User Info