@sekwiatkowski/js-fp/dist/box/Box.d.ts

A pragmatic functional programming library for JavaScript/TypeScript

import { Equivalence, Future, Option, Predicate, Result, Semigroup, Validated } from '..';
export declare class Box<A> {
    private readonly value;
    constructor(value: A);
    get(): A;
    get<T>(f: (value: A) => T): T;
    apply<B, C>(this: Box<(parameter: B) => C>, argumentOrBoxOrFunction: B | Box<B> | (() => B) | (() => Box<B>)): Box<C>;
    chain<B>(f: (value: A) => Box<B>): Box<B>;
    assign<A extends object, K extends string, B>(this: Box<A>, key: Exclude<K, keyof A>, memberBoxOrValueOrFunction: Box<B> | ((scope: A) => Box<B>) | B | ((scope: A) => B)): Box<A & {
        [key in K]: B;
    }>;
    combine(otherValueOrBox: A | Box<A>, semigroup: Semigroup<A>): Box<A>;
    toFuture<E>(): Future<A, E>;
    toOption(): Option<A>;
    toResult<E>(): Result<A, E>;
    toValidated<E>(): Validated<A, E>;
    map<B>(f: (value: A) => B): Box<B>;
    perform(sideEffect: (value: A) => void): Box<A>;
    equals(otherBox: Box<A>, equality: Equivalence<Box<A>>): boolean;
    test(predicate: (value: A) => boolean): boolean;
    test(predicate: Predicate<A>): boolean;
}
export declare function box<A>(value: A): Box<A>;
export declare function boxObject(): Box<{}>;
export declare function createBoxEquality<T>(valueEquality?: Equivalence<T>): Equivalence<Box<T>>;