MAINHACK

Viewing / Editing File: Boolean.d.ts

/**
 * This module provides utility functions and type class instances for working with the `boolean` type in TypeScript.
 * It includes functions for basic boolean operations, as well as type class instances for
 * `Equivalence` and `Order`.
 *
 * @since 2.0.0
 */
import * as equivalence from "./Equivalence.js";
import type { LazyArg } from "./Function.js";
import * as order from "./Order.js";
/**
 * Tests if a value is a `boolean`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { isBoolean } from "effect/Boolean"
 *
 * assert.deepStrictEqual(isBoolean(true), true)
 * assert.deepStrictEqual(isBoolean("true"), false)
 * ```
 *
 * @category guards
 * @since 2.0.0
 */
export declare const isBoolean: (input: unknown) => input is boolean;
/**
 * This function returns the result of either of the given functions depending on the value of the boolean parameter.
 * It is useful when you have to run one of two functions depending on the boolean value.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { Boolean } from "effect"
 *
 * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
 * ```
 *
 * @category pattern matching
 * @since 2.0.0
 */
export declare const match: {
    /**
     * This function returns the result of either of the given functions depending on the value of the boolean parameter.
     * It is useful when you have to run one of two functions depending on the boolean value.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { Boolean } from "effect"
     *
     * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
     * ```
     *
     * @category pattern matching
     * @since 2.0.0
     */
    <A, B = A>(options: {
        readonly onFalse: LazyArg<A>;
        readonly onTrue: LazyArg<B>;
    }): (value: boolean) => A | B;
    /**
     * This function returns the result of either of the given functions depending on the value of the boolean parameter.
     * It is useful when you have to run one of two functions depending on the boolean value.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { Boolean } from "effect"
     *
     * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
     * ```
     *
     * @category pattern matching
     * @since 2.0.0
     */
    <A, B>(value: boolean, options: {
        readonly onFalse: LazyArg<A>;
        readonly onTrue: LazyArg<B>;
    }): A | B;
};
/**
 * @category instances
 * @since 2.0.0
 */
export declare const Equivalence: equivalence.Equivalence<boolean>;
/**
 * @category instances
 * @since 2.0.0
 */
export declare const Order: order.Order<boolean>;
/**
 * Negates the given boolean: `!self`
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { not } from "effect/Boolean"
 *
 * assert.deepStrictEqual(not(true), false)
 * assert.deepStrictEqual(not(false), true)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const not: (self: boolean) => boolean;
/**
 * Combines two boolean using AND: `self && that`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { and } from "effect/Boolean"
 *
 * assert.deepStrictEqual(and(true, true), true)
 * assert.deepStrictEqual(and(true, false), false)
 * assert.deepStrictEqual(and(false, true), false)
 * assert.deepStrictEqual(and(false, false), false)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const and: {
    /**
     * Combines two boolean using AND: `self && that`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { and } from "effect/Boolean"
     *
     * assert.deepStrictEqual(and(true, true), true)
     * assert.deepStrictEqual(and(true, false), false)
     * assert.deepStrictEqual(and(false, true), false)
     * assert.deepStrictEqual(and(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two boolean using AND: `self && that`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { and } from "effect/Boolean"
     *
     * assert.deepStrictEqual(and(true, true), true)
     * assert.deepStrictEqual(and(true, false), false)
     * assert.deepStrictEqual(and(false, true), false)
     * assert.deepStrictEqual(and(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two boolean using NAND: `!(self && that)`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { nand } from "effect/Boolean"
 *
 * assert.deepStrictEqual(nand(true, true), false)
 * assert.deepStrictEqual(nand(true, false), true)
 * assert.deepStrictEqual(nand(false, true), true)
 * assert.deepStrictEqual(nand(false, false), true)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const nand: {
    /**
     * Combines two boolean using NAND: `!(self && that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { nand } from "effect/Boolean"
     *
     * assert.deepStrictEqual(nand(true, true), false)
     * assert.deepStrictEqual(nand(true, false), true)
     * assert.deepStrictEqual(nand(false, true), true)
     * assert.deepStrictEqual(nand(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two boolean using NAND: `!(self && that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { nand } from "effect/Boolean"
     *
     * assert.deepStrictEqual(nand(true, true), false)
     * assert.deepStrictEqual(nand(true, false), true)
     * assert.deepStrictEqual(nand(false, true), true)
     * assert.deepStrictEqual(nand(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two boolean using OR: `self || that`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { or } from "effect/Boolean"
 *
 * assert.deepStrictEqual(or(true, true), true)
 * assert.deepStrictEqual(or(true, false), true)
 * assert.deepStrictEqual(or(false, true), true)
 * assert.deepStrictEqual(or(false, false), false)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const or: {
    /**
     * Combines two boolean using OR: `self || that`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { or } from "effect/Boolean"
     *
     * assert.deepStrictEqual(or(true, true), true)
     * assert.deepStrictEqual(or(true, false), true)
     * assert.deepStrictEqual(or(false, true), true)
     * assert.deepStrictEqual(or(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two boolean using OR: `self || that`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { or } from "effect/Boolean"
     *
     * assert.deepStrictEqual(or(true, true), true)
     * assert.deepStrictEqual(or(true, false), true)
     * assert.deepStrictEqual(or(false, true), true)
     * assert.deepStrictEqual(or(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two booleans using NOR: `!(self || that)`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { nor } from "effect/Boolean"
 *
 * assert.deepStrictEqual(nor(true, true), false)
 * assert.deepStrictEqual(nor(true, false), false)
 * assert.deepStrictEqual(nor(false, true), false)
 * assert.deepStrictEqual(nor(false, false), true)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const nor: {
    /**
     * Combines two booleans using NOR: `!(self || that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { nor } from "effect/Boolean"
     *
     * assert.deepStrictEqual(nor(true, true), false)
     * assert.deepStrictEqual(nor(true, false), false)
     * assert.deepStrictEqual(nor(false, true), false)
     * assert.deepStrictEqual(nor(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two booleans using NOR: `!(self || that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { nor } from "effect/Boolean"
     *
     * assert.deepStrictEqual(nor(true, true), false)
     * assert.deepStrictEqual(nor(true, false), false)
     * assert.deepStrictEqual(nor(false, true), false)
     * assert.deepStrictEqual(nor(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { xor } from "effect/Boolean"
 *
 * assert.deepStrictEqual(xor(true, true), false)
 * assert.deepStrictEqual(xor(true, false), true)
 * assert.deepStrictEqual(xor(false, true), true)
 * assert.deepStrictEqual(xor(false, false), false)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const xor: {
    /**
     * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { xor } from "effect/Boolean"
     *
     * assert.deepStrictEqual(xor(true, true), false)
     * assert.deepStrictEqual(xor(true, false), true)
     * assert.deepStrictEqual(xor(false, true), true)
     * assert.deepStrictEqual(xor(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { xor } from "effect/Boolean"
     *
     * assert.deepStrictEqual(xor(true, true), false)
     * assert.deepStrictEqual(xor(true, false), true)
     * assert.deepStrictEqual(xor(false, true), true)
     * assert.deepStrictEqual(xor(false, false), false)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { eqv } from "effect/Boolean"
 *
 * assert.deepStrictEqual(eqv(true, true), true)
 * assert.deepStrictEqual(eqv(true, false), false)
 * assert.deepStrictEqual(eqv(false, true), false)
 * assert.deepStrictEqual(eqv(false, false), true)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const eqv: {
    /**
     * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { eqv } from "effect/Boolean"
     *
     * assert.deepStrictEqual(eqv(true, true), true)
     * assert.deepStrictEqual(eqv(true, false), false)
     * assert.deepStrictEqual(eqv(false, true), false)
     * assert.deepStrictEqual(eqv(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { eqv } from "effect/Boolean"
     *
     * assert.deepStrictEqual(eqv(true, true), true)
     * assert.deepStrictEqual(eqv(true, false), false)
     * assert.deepStrictEqual(eqv(false, true), false)
     * assert.deepStrictEqual(eqv(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * Combines two booleans using an implication: `(!self || that)`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { implies } from "effect/Boolean"
 *
 * assert.deepStrictEqual(implies(true, true), true)
 * assert.deepStrictEqual(implies(true, false), false)
 * assert.deepStrictEqual(implies(false, true), true)
 * assert.deepStrictEqual(implies(false, false), true)
 * ```
 *
 * @category combinators
 * @since 2.0.0
 */
export declare const implies: {
    /**
     * Combines two booleans using an implication: `(!self || that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { implies } from "effect/Boolean"
     *
     * assert.deepStrictEqual(implies(true, true), true)
     * assert.deepStrictEqual(implies(true, false), false)
     * assert.deepStrictEqual(implies(false, true), true)
     * assert.deepStrictEqual(implies(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (that: boolean): (self: boolean) => boolean;
    /**
     * Combines two booleans using an implication: `(!self || that)`.
     *
     * @example
     * ```ts
     * import * as assert from "node:assert"
     * import { implies } from "effect/Boolean"
     *
     * assert.deepStrictEqual(implies(true, true), true)
     * assert.deepStrictEqual(implies(true, false), false)
     * assert.deepStrictEqual(implies(false, true), true)
     * assert.deepStrictEqual(implies(false, false), true)
     * ```
     *
     * @category combinators
     * @since 2.0.0
     */
    (self: boolean, that: boolean): boolean;
};
/**
 * This utility function is used to check if all the elements in a collection of boolean values are `true`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { every } from "effect/Boolean"
 *
 * assert.deepStrictEqual(every([true, true, true]), true)
 * assert.deepStrictEqual(every([true, false, true]), false)
 * ```
 *
 * @since 2.0.0
 */
export declare const every: (collection: Iterable<boolean>) => boolean;
/**
 * This utility function is used to check if at least one of the elements in a collection of boolean values is `true`.
 *
 * @example
 * ```ts
 * import * as assert from "node:assert"
 * import { some } from "effect/Boolean"
 *
 * assert.deepStrictEqual(some([true, false, true]), true)
 * assert.deepStrictEqual(some([false, false, false]), false)
 * ```
 *
 * @since 2.0.0
 */
export declare const some: (collection: Iterable<boolean>) => boolean;
//# sourceMappingURL=Boolean.d.ts.map

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: Boolean.d.ts

Server Info

System Features

User Info