UNPKG

fp-ts

Version:

Functional programming in TypeScript

670 lines (669 loc) 28.5 kB
/** * The error monad transformer. It can be used to add error handling to other monads. * * The `of` function yields a successful computation, while `chain` sequences two subcomputations, failing on the first error. * * @since 2.0.0 */ import { ApplicativeComposition12, ApplicativeComposition22, ApplicativeCompositionHKT2 } from './Applicative' import { Apply, Apply1, Apply2, Apply2C, Apply3, Apply3C } from './Apply' import { Chain, Chain1, Chain2, Chain2C, Chain3, Chain3C } from './Chain' import * as E from './Either' import { LazyArg } from './function' import { Functor, Functor1, Functor2, Functor2C, Functor3, Functor3C } from './Functor' import { HKT, Kind, Kind2, Kind3, URIS, URIS2, URIS3 } from './HKT' import { Monad, Monad1, Monad2, Monad2C, Monad3, Monad3C } from './Monad' import { Pointed, Pointed1, Pointed2, Pointed2C, Pointed3, Pointed3C } from './Pointed' import { Semigroup } from './Semigroup' import Either = E.Either /** * @since 2.10.0 */ export declare function right<F extends URIS3>( F: Pointed3<F> ): <A, R, FE, E = never>(a: A) => Kind3<F, R, FE, Either<E, A>> export declare function right<F extends URIS3, FE>( F: Pointed3C<F, FE> ): <A, R, E = never>(a: A) => Kind3<F, R, FE, Either<E, A>> export declare function right<F extends URIS2>(F: Pointed2<F>): <A, FE, E = never>(a: A) => Kind2<F, FE, Either<E, A>> export declare function right<F extends URIS2, FE>( F: Pointed2C<F, FE> ): <A, E = never>(a: A) => Kind2<F, FE, Either<E, A>> export declare function right<F extends URIS>(F: Pointed1<F>): <A, E = never>(a: A) => Kind<F, Either<E, A>> export declare function right<F>(F: Pointed<F>): <A, E = never>(a: A) => HKT<F, Either<E, A>> /** * @since 2.10.0 */ export declare function left<F extends URIS3>( F: Pointed3<F> ): <E, R, FE, A = never>(e: E) => Kind3<F, R, FE, Either<E, A>> export declare function left<F extends URIS3, FE>( F: Pointed3C<F, FE> ): <E, R, A = never>(e: E) => Kind3<F, R, FE, Either<E, A>> export declare function left<F extends URIS2>(F: Pointed2<F>): <E, FE, A = never>(e: E) => Kind2<F, FE, Either<E, A>> export declare function left<F extends URIS2, FE>( F: Pointed2C<F, FE> ): <E, A = never>(e: E) => Kind2<F, FE, Either<E, A>> export declare function left<F extends URIS>(F: Pointed1<F>): <E, A = never>(e: E) => Kind<F, Either<E, A>> export declare function left<F>(F: Pointed<F>): <E, A = never>(e: E) => HKT<F, Either<E, A>> /** * @since 2.10.0 */ export declare function rightF<F extends URIS3>( F: Functor3<F> ): <R, FE, A, E = never>(fa: Kind3<F, R, FE, A>) => Kind3<F, R, FE, Either<E, A>> export declare function rightF<F extends URIS3, FE>( F: Functor3C<F, FE> ): <R, A, E = never>(fa: Kind3<F, R, FE, A>) => Kind3<F, R, FE, Either<E, A>> export declare function rightF<F extends URIS2>( F: Functor2<F> ): <FE, A, E = never>(fa: Kind2<F, FE, A>) => Kind2<F, FE, Either<E, A>> export declare function rightF<F extends URIS2, FE>( F: Functor2C<F, FE> ): <A, E = never>(fa: Kind2<F, FE, A>) => Kind2<F, FE, Either<E, A>> export declare function rightF<F extends URIS>(F: Functor1<F>): <A, E = never>(fa: Kind<F, A>) => Kind<F, Either<E, A>> export declare function rightF<F>(F: Functor<F>): <A, E = never>(fa: HKT<F, A>) => HKT<F, Either<E, A>> /** * @since 2.10.0 */ export declare function leftF<F extends URIS3>( F: Functor3<F> ): <R, FE, E, A = never>(fe: Kind3<F, R, FE, E>) => Kind3<F, R, FE, Either<E, A>> export declare function leftF<F extends URIS3, FE>( F: Functor3C<F, FE> ): <R, E, A = never>(fe: Kind3<F, R, FE, E>) => Kind3<F, R, FE, Either<E, A>> export declare function leftF<F extends URIS2>( F: Functor2<F> ): <FE, E, A = never>(fe: Kind2<F, FE, E>) => Kind2<F, FE, Either<E, A>> export declare function leftF<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, A = never>(fe: Kind2<F, FE, E>) => Kind2<F, FE, Either<E, A>> export declare function leftF<F extends URIS>(F: Functor1<F>): <E, A = never>(fe: Kind<F, E>) => Kind<F, Either<E, A>> export declare function leftF<F>(F: Functor<F>): <E, A = never>(fe: HKT<F, E>) => HKT<F, Either<E, A>> /** * @since 2.12.0 */ export declare function fromNullable<F extends URIS3>( F: Pointed3<F> ): <E>(e: E) => <A, S, R>(a: A) => Kind3<F, S, R, Either<E, NonNullable<A>>> export declare function fromNullable<F extends URIS3, R>( F: Pointed3C<F, R> ): <E>(e: E) => <A, S>(a: A) => Kind3<F, S, R, Either<E, NonNullable<A>>> export declare function fromNullable<F extends URIS2>( F: Pointed2<F> ): <E>(e: E) => <A, R>(a: A) => Kind2<F, R, Either<E, NonNullable<A>>> export declare function fromNullable<F extends URIS2, R>( F: Pointed2C<F, R> ): <E>(e: E) => <A>(a: A) => Kind2<F, R, Either<E, NonNullable<A>>> export declare function fromNullable<F extends URIS>( F: Pointed1<F> ): <E>(e: E) => <A>(a: A) => Kind<F, Either<E, NonNullable<A>>> export declare function fromNullable<F>(F: Pointed<F>): <E>(e: E) => <A>(a: A) => HKT<F, Either<E, NonNullable<A>>> /** * @since 2.12.0 */ export declare function fromNullableK<F extends URIS3>( F: Pointed3<F> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => <S, R>(...a: A) => Kind3<F, S, R, Either<E, NonNullable<B>>> export declare function fromNullableK<F extends URIS3, R>( F: Pointed3C<F, R> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => <S>(...a: A) => Kind3<F, S, R, Either<E, NonNullable<B>>> export declare function fromNullableK<F extends URIS2>( F: Pointed2<F> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => <R>(...a: A) => Kind2<F, R, Either<E, NonNullable<B>>> export declare function fromNullableK<F extends URIS2, R>( F: Pointed2C<F, R> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => (...a: A) => Kind2<F, R, Either<E, NonNullable<B>>> export declare function fromNullableK<F extends URIS>( F: Pointed1<F> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => (...a: A) => Kind<F, Either<E, NonNullable<B>>> export declare function fromNullableK<F>( F: Pointed<F> ): <E>( e: E ) => <A extends ReadonlyArray<unknown>, B>( f: (...a: A) => B | null | undefined ) => (...a: A) => HKT<F, Either<E, NonNullable<B>>> /** * @since 2.12.0 */ export declare function chainNullableK<M extends URIS3>( M: Monad3<M> ): <E>( e: E ) => <A, B>( f: (a: A) => B | null | undefined ) => <S, R>(ma: Kind3<M, S, R, Either<E, A>>) => Kind3<M, S, R, Either<E, NonNullable<B>>> export declare function chainNullableK<M extends URIS3, R>( M: Monad3C<M, R> ): <E>( e: E ) => <A, B>( f: (a: A) => B | null | undefined ) => <S>(ma: Kind3<M, S, R, Either<E, A>>) => Kind3<M, S, R, Either<E, NonNullable<B>>> export declare function chainNullableK<M extends URIS2>( M: Monad2<M> ): <E>( e: E ) => <A, B>( f: (a: A) => B | null | undefined ) => <R>(ma: Kind2<M, R, Either<E, A>>) => Kind2<M, R, Either<E, NonNullable<B>>> export declare function chainNullableK<M extends URIS2, T>( M: Monad2C<M, T> ): <E>( e: E ) => <A, B>( f: (a: A) => B | null | undefined ) => (ma: Kind2<M, T, Either<E, A>>) => Kind2<M, T, Either<E, NonNullable<B>>> export declare function chainNullableK<M extends URIS>( M: Monad1<M> ): <E>( e: E ) => <A, B>(f: (a: A) => B | null | undefined) => (ma: Kind<M, Either<E, A>>) => Kind<M, Either<E, NonNullable<B>>> export declare function chainNullableK<M>( M: Monad<M> ): <E>( e: E ) => <A, B>(f: (a: A) => B | null | undefined) => (ma: HKT<M, Either<E, A>>) => HKT<M, Either<E, NonNullable<B>>> /** * @since 2.10.0 */ export declare function map<F extends URIS3>( F: Functor3<F> ): <A, B>(f: (a: A) => B) => <R, FE, E>(fa: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<E, B>> export declare function map<F extends URIS3, FE>( F: Functor3C<F, FE> ): <A, B>(f: (a: A) => B) => <R, E>(fa: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<E, B>> export declare function map<F extends URIS2>( F: Functor2<F> ): <A, B>(f: (a: A) => B) => <FE, E>(fa: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<E, B>> export declare function map<F extends URIS2, FE>( F: Functor2C<F, FE> ): <A, B>(f: (a: A) => B) => <E>(fa: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<E, B>> export declare function map<F extends URIS>( F: Functor1<F> ): <A, B>(f: (a: A) => B) => <E>(fa: Kind<F, Either<E, A>>) => Kind<F, Either<E, B>> export declare function map<F>( F: Functor<F> ): <A, B>(f: (a: A) => B) => <E>(fa: HKT<F, Either<E, A>>) => HKT<F, Either<E, B>> /** * @since 2.10.0 */ export declare function ap<F extends URIS3>( F: Apply3<F> ): <R, FE, E, A>( fa: Kind3<F, R, FE, Either<E, A>> ) => <B>(fab: Kind3<F, R, FE, Either<E, (a: A) => B>>) => Kind3<F, R, FE, Either<E, B>> export declare function ap<F extends URIS3, FE>( F: Apply3C<F, FE> ): <R, E, A>( fa: Kind3<F, R, FE, Either<E, A>> ) => <B>(fab: Kind3<F, R, FE, Either<E, (a: A) => B>>) => Kind3<F, R, FE, Either<E, B>> export declare function ap<F extends URIS2>( F: Apply2<F> ): <FE, E, A>( fa: Kind2<F, FE, Either<E, A>> ) => <B>(fab: Kind2<F, FE, Either<E, (a: A) => B>>) => Kind2<F, FE, Either<E, B>> export declare function ap<F extends URIS2, FE>( F: Apply2C<F, FE> ): <E, A>( fa: Kind2<F, FE, Either<E, A>> ) => <B>(fab: Kind2<F, FE, Either<E, (a: A) => B>>) => Kind2<F, FE, Either<E, B>> export declare function ap<F extends URIS>( F: Apply1<F> ): <E, A>(fa: Kind<F, Either<E, A>>) => <B>(fab: Kind<F, Either<E, (a: A) => B>>) => Kind<F, Either<E, B>> export declare function ap<F>( F: Apply<F> ): <E, A>(fa: HKT<F, Either<E, A>>) => <B>(fab: HKT<F, Either<E, (a: A) => B>>) => HKT<F, Either<E, B>> /** * @since 2.10.0 */ export declare function chain<M extends URIS3>( M: Monad3<M> ): <A, R, ME, E, B>( f: (a: A) => Kind3<M, R, ME, Either<E, B>> ) => (ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, B>> export declare function chain<M extends URIS3, ME>( M: Monad3C<M, ME> ): <A, R, E, B>( f: (a: A) => Kind3<M, R, ME, Either<E, B>> ) => (ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, B>> export declare function chain<M extends URIS2>( M: Monad2<M> ): <A, ME, E, B>( f: (a: A) => Kind2<M, ME, Either<E, B>> ) => (ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, B>> export declare function chain<M extends URIS2, ME>( M: Monad2C<M, ME> ): <A, E, B>(f: (a: A) => Kind2<M, ME, Either<E, B>>) => (ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, B>> export declare function chain<M extends URIS>( M: Monad1<M> ): <A, E, B>(f: (a: A) => Kind<M, Either<E, B>>) => (ma: Kind<M, Either<E, A>>) => Kind<M, Either<E, B>> export declare function chain<M>( M: Monad<M> ): <A, E, B>(f: (a: A) => HKT<M, Either<E, B>>) => (ma: HKT<M, Either<E, A>>) => HKT<M, Either<E, B>> /** * @since 2.10.0 */ export declare function alt<M extends URIS3>( M: Monad3<M> ): <R, ME, E, A>( second: LazyArg<Kind3<M, R, ME, Either<E, A>>> ) => (first: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function alt<M extends URIS3, ME>( M: Monad3C<M, ME> ): <R, E, A>( second: LazyArg<Kind3<M, R, ME, Either<E, A>>> ) => (first: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function alt<M extends URIS2>( M: Monad2<M> ): <ME, E, A>( second: LazyArg<Kind2<M, ME, Either<E, A>>> ) => (first: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function alt<M extends URIS2, ME>( M: Monad2C<M, ME> ): <E, A>( second: LazyArg<Kind2<M, ME, Either<E, A>>> ) => (first: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function alt<M extends URIS>( M: Monad1<M> ): <E, A>(second: LazyArg<Kind<M, Either<E, A>>>) => (first: Kind<M, Either<E, A>>) => Kind<M, Either<E, A>> export declare function alt<M>( M: Monad<M> ): <E, A>(second: LazyArg<HKT<M, Either<E, A>>>) => (first: HKT<M, Either<E, A>>) => HKT<M, Either<E, A>> /** * @since 2.10.0 */ export declare function bimap<F extends URIS3>( F: Functor3<F> ): <E, G, A, B>( f: (e: E) => G, g: (a: A) => B ) => <R, FE>(self: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<G, B>> export declare function bimap<F extends URIS3, FE>( F: Functor3C<F, FE> ): <E, G, A, B>( f: (e: E) => G, g: (a: A) => B ) => <R>(self: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<G, B>> export declare function bimap<F extends URIS2>( F: Functor2<F> ): <E, G, A, B>(f: (e: E) => G, g: (a: A) => B) => <FE>(self: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<G, B>> export declare function bimap<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, G, A, B>(f: (e: E) => G, g: (a: A) => B) => (self: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<G, B>> export declare function bimap<F extends URIS>( F: Functor1<F> ): <E, G, A, B>(f: (e: E) => G, g: (a: A) => B) => (self: Kind<F, Either<E, A>>) => Kind<F, Either<G, B>> export declare function bimap<F>( F: Functor<F> ): <E, G, A, B>(f: (e: E) => G, g: (a: A) => B) => (self: HKT<F, Either<E, A>>) => HKT<F, Either<G, B>> /** * @since 2.10.0 */ export declare function mapLeft<F extends URIS3>( F: Functor3<F> ): <E, G>(f: (e: E) => G) => <R, FE, A>(self: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<G, A>> export declare function mapLeft<F extends URIS3, FE>( F: Functor3C<F, FE> ): <E, G>(f: (e: E) => G) => <R, A>(self: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<G, A>> export declare function mapLeft<F extends URIS2>( F: Functor2<F> ): <E, G>(f: (e: E) => G) => <FE, A>(self: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<G, A>> export declare function mapLeft<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, G>(f: (e: E) => G) => <A>(self: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<G, A>> export declare function mapLeft<F extends URIS>( F: Functor1<F> ): <E, G>(f: (e: E) => G) => <A>(self: Kind<F, Either<E, A>>) => Kind<F, Either<G, A>> export declare function mapLeft<F>( F: Functor<F> ): <E, G>(f: (e: E) => G) => <A>(self: HKT<F, Either<E, A>>) => HKT<F, Either<G, A>> /** * @category error handling * @since 2.10.0 */ export declare function altValidation<M extends URIS3, E>( M: Monad3<M>, S: Semigroup<E> ): <R, ME, A>( second: LazyArg<Kind3<M, R, ME, Either<E, A>>> ) => (first: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function altValidation<M extends URIS3, ME, E>( M: Monad3C<M, ME>, S: Semigroup<E> ): <R, A>( second: LazyArg<Kind3<M, R, ME, Either<E, A>>> ) => (first: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function altValidation<M extends URIS2, E>( M: Monad2<M>, S: Semigroup<E> ): <ME, A>( second: LazyArg<Kind2<M, ME, Either<E, A>>> ) => (first: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function altValidation<M extends URIS2, ME, E>( M: Monad2C<M, ME>, S: Semigroup<E> ): <A>(second: LazyArg<Kind2<M, ME, Either<E, A>>>) => (first: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function altValidation<M extends URIS, E>( M: Monad1<M>, S: Semigroup<E> ): <A>(second: LazyArg<Kind<M, Either<E, A>>>) => (first: Kind<M, Either<E, A>>) => Kind<M, Either<E, A>> export declare function altValidation<M, E>( M: Monad<M>, S: Semigroup<E> ): <A>(second: LazyArg<HKT<M, Either<E, A>>>) => (first: HKT<M, Either<E, A>>) => HKT<M, Either<E, A>> /** * @category pattern matching * @since 2.11.0 */ export declare function match<F extends URIS3>( F: Functor3<F> ): <E, B, A>( onLeft: (e: E) => B, onRight: (a: A) => B ) => <R, ME>(ma: Kind3<F, R, ME, Either<E, A>>) => Kind3<F, R, ME, B> export declare function match<F extends URIS3, FE>( F: Functor3C<F, FE> ): <E, B, A>(onLeft: (e: E) => B, onRight: (a: A) => B) => <R>(ma: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, B> export declare function match<F extends URIS2>( F: Functor2<F> ): <E, B, A>(onLeft: (e: E) => B, onRight: (a: A) => B) => <FE>(ma: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, B> export declare function match<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, B, A>(onLeft: (e: E) => B, onRight: (a: A) => B) => (ma: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, B> export declare function match<F extends URIS>( F: Functor1<F> ): <E, B, A>(onLeft: (e: E) => B, onRight: (a: A) => B) => (ma: Kind<F, Either<E, A>>) => Kind<F, B> export declare function match<F>( F: Functor<F> ): <E, B, A>(onLeft: (e: E) => B, onRight: (a: A) => B) => (ma: HKT<F, Either<E, A>>) => HKT<F, B> /** * @since 2.10.0 */ export declare function matchE<M extends URIS3>( M: Chain3<M> ): <E, R, FE, B, A>( onLeft: (e: E) => Kind3<M, R, FE, B>, onRight: (a: A) => Kind3<M, R, FE, B> ) => (ma: Kind3<M, R, FE, Either<E, A>>) => Kind3<M, R, FE, B> export declare function matchE<M extends URIS3, FE>( M: Chain3C<M, FE> ): <E, R, B, A>( onLeft: (e: E) => Kind3<M, R, FE, B>, onRight: (a: A) => Kind3<M, R, FE, B> ) => (ma: Kind3<M, R, FE, Either<E, A>>) => Kind3<M, R, FE, B> export declare function matchE<M extends URIS2>( M: Chain2<M> ): <E, FE, B, A>( onLeft: (e: E) => Kind2<M, FE, B>, onRight: (a: A) => Kind2<M, FE, B> ) => (ma: Kind2<M, FE, Either<E, A>>) => Kind2<M, FE, B> export declare function matchE<M extends URIS2, FE>( M: Chain2C<M, FE> ): <E, B, A>( onLeft: (e: E) => Kind2<M, FE, B>, onRight: (a: A) => Kind2<M, FE, B> ) => (ma: Kind2<M, FE, Either<E, A>>) => Kind2<M, FE, B> export declare function matchE<M extends URIS>( M: Chain1<M> ): <E, B, A>(onLeft: (e: E) => Kind<M, B>, onRight: (a: A) => Kind<M, B>) => (ma: Kind<M, Either<E, A>>) => Kind<M, B> export declare function matchE<M>( M: Chain<M> ): <E, B, A>(onLeft: (e: E) => HKT<M, B>, onRight: (a: A) => HKT<M, B>) => (ma: HKT<M, Either<E, A>>) => HKT<M, B> /** * @since 2.10.0 */ export declare function getOrElse<M extends URIS3>( M: Monad3<M> ): <E, R, ME, A>(onLeft: (e: E) => Kind3<M, R, ME, A>) => (ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, A> export declare function getOrElse<M extends URIS3, ME>( M: Monad3C<M, ME> ): <E, R, A>(onLeft: (e: E) => Kind3<M, R, ME, A>) => (ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, A> export declare function getOrElse<M extends URIS2>( M: Monad2<M> ): <E, ME, A>(onLeft: (e: E) => Kind2<M, ME, A>) => (ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, A> export declare function getOrElse<M extends URIS2, ME>( M: Monad2C<M, ME> ): <E, A>(onLeft: (e: E) => Kind2<M, ME, A>) => (ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, A> export declare function getOrElse<M extends URIS>( M: Monad1<M> ): <E, A>(onLeft: (e: E) => Kind<M, A>) => (ma: Kind<M, Either<E, A>>) => Kind<M, A> export declare function getOrElse<M>( M: Monad<M> ): <E, A>(onLeft: (e: E) => HKT<M, A>) => (ma: HKT<M, Either<E, A>>) => HKT<M, A> /** * @since 2.10.0 */ export declare function orElse<M extends URIS3>( M: Monad3<M> ): <E1, R, ME, E2, A>( onLeft: (e: E1) => Kind3<M, R, ME, Either<E2, A>> ) => (ma: Kind3<M, R, ME, Either<E1, A>>) => Kind3<M, R, ME, Either<E2, A>> export declare function orElse<M extends URIS3, ME>( M: Monad3C<M, ME> ): <E1, R, E2, A>( onLeft: (e: E1) => Kind3<M, R, ME, Either<E2, A>> ) => (ma: Kind3<M, R, ME, Either<E1, A>>) => Kind3<M, R, ME, Either<E2, A>> export declare function orElse<M extends URIS2>( M: Monad2<M> ): <E1, ME, E2, A>( onLeft: (e: E1) => Kind2<M, ME, Either<E2, A>> ) => (ma: Kind2<M, ME, Either<E1, A>>) => Kind2<M, ME, Either<E2, A>> export declare function orElse<M extends URIS2, ME>( M: Monad2C<M, ME> ): <E1, E2, A>( onLeft: (e: E1) => Kind2<M, ME, Either<E2, A>> ) => (ma: Kind2<M, ME, Either<E1, A>>) => Kind2<M, ME, Either<E2, A>> export declare function orElse<M extends URIS>( M: Monad1<M> ): <E1, E2, A>(onLeft: (e: E1) => Kind<M, Either<E2, A>>) => (ma: Kind<M, Either<E1, A>>) => Kind<M, Either<E2, A>> export declare function orElse<M>( M: Monad<M> ): <E1, E2, A>(onLeft: (e: E1) => HKT<M, Either<E2, A>>) => (ma: HKT<M, Either<E1, A>>) => HKT<M, Either<E2, A>> /** * @category error handling * @since 2.11.0 */ export declare function orElseFirst<M extends URIS3>( M: Monad3<M> ): <E, R, ME, B>( onLeft: (e: E) => Kind3<M, R, ME, Either<E, B>> ) => <A>(ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function orElseFirst<M extends URIS3, ME>( M: Monad3C<M, ME> ): <E, R, B>( onLeft: (e: E) => Kind3<M, R, ME, Either<E, B>> ) => <A>(ma: Kind3<M, R, ME, Either<E, A>>) => Kind3<M, R, ME, Either<E, A>> export declare function orElseFirst<M extends URIS2>( M: Monad2<M> ): <E, ME, B>( onLeft: (e: E) => Kind2<M, ME, Either<E, B>> ) => <A>(ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function orElseFirst<M extends URIS2, ME>( M: Monad2C<M, ME> ): <E, B>( onLeft: (e: E) => Kind2<M, ME, Either<E, B>> ) => <A>(ma: Kind2<M, ME, Either<E, A>>) => Kind2<M, ME, Either<E, A>> export declare function orElseFirst<M extends URIS>( M: Monad1<M> ): <E, B>(onLeft: (e: E) => Kind<M, Either<E, B>>) => <A>(ma: Kind<M, Either<E, A>>) => Kind<M, Either<E, A>> export declare function orElseFirst<M>( M: Monad<M> ): <E, B>(onLeft: (e: E) => HKT<M, Either<E, B>>) => <A>(ma: HKT<M, Either<E, A>>) => HKT<M, Either<E, A>> /** * @category error handling * @since 2.11.0 */ export declare function orLeft<M extends URIS3>( M: Monad3<M> ): <E1, R, ME, E2>( onLeft: (e: E1) => Kind3<M, R, ME, E2> ) => <A>(fa: Kind3<M, R, ME, Either<E1, A>>) => Kind3<M, R, ME, Either<E2, A>> export declare function orLeft<M extends URIS3, ME>( M: Monad3C<M, ME> ): <E1, R, E2>( onLeft: (e: E1) => Kind3<M, R, ME, E2> ) => <A>(fa: Kind3<M, R, ME, Either<E1, A>>) => Kind3<M, R, ME, Either<E2, A>> export declare function orLeft<M extends URIS2>( M: Monad2<M> ): <E1, ME, E2>( onLeft: (e: E1) => Kind2<M, ME, E2> ) => <A>(fa: Kind2<M, ME, Either<E1, A>>) => Kind2<M, ME, Either<E2, A>> export declare function orLeft<M extends URIS2, ME>( M: Monad2C<M, ME> ): <E1, E2>(onLeft: (e: E1) => Kind2<M, ME, E2>) => <A>(fa: Kind2<M, ME, Either<E1, A>>) => Kind2<M, ME, Either<E2, A>> export declare function orLeft<M extends URIS>( M: Monad1<M> ): <E1, E2>(onLeft: (e: E1) => Kind<M, E2>) => <A>(fa: Kind<M, Either<E1, A>>) => Kind<M, Either<E2, A>> export declare function orLeft<M>( M: Monad<M> ): <E1, E2>(onLeft: (e: E1) => HKT<M, E2>) => <A>(fa: HKT<M, Either<E1, A>>) => HKT<M, Either<E2, A>> /** * @since 2.10.0 */ export declare function swap<F extends URIS3>( F: Functor3<F> ): <R, FE, E, A>(ma: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<A, E>> export declare function swap<F extends URIS3, FE>( F: Functor3C<F, FE> ): <R, E, A>(ma: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, Either<A, E>> export declare function swap<F extends URIS2>( F: Functor2<F> ): <FE, E, A>(ma: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<A, E>> export declare function swap<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, A>(ma: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, Either<A, E>> export declare function swap<F extends URIS>(F: Functor1<F>): <E, A>(ma: Kind<F, Either<E, A>>) => Kind<F, Either<A, E>> export declare function swap<F>(F: Functor<F>): <E, A>(ma: HKT<F, Either<E, A>>) => HKT<F, Either<A, E>> /** * @since 2.10.0 */ export declare function toUnion<F extends URIS3>( F: Functor3<F> ): <R, FE, E, A>(fa: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, E | A> export declare function toUnion<F extends URIS3, FE>( F: Functor3C<F, FE> ): <R, E, A>(fa: Kind3<F, R, FE, Either<E, A>>) => Kind3<F, R, FE, E | A> export declare function toUnion<F extends URIS2>( F: Functor2<F> ): <FE, E, A>(fa: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, E | A> export declare function toUnion<F extends URIS2, FE>( F: Functor2C<F, FE> ): <E, A>(fa: Kind2<F, FE, Either<E, A>>) => Kind2<F, FE, E | A> export declare function toUnion<F extends URIS>(F: Functor1<F>): <E, A>(fa: Kind<F, Either<E, A>>) => Kind<F, E | A> export declare function toUnion<F>(F: Functor<F>): <E, A>(fa: HKT<F, Either<E, A>>) => HKT<F, E | A> import URI = E.URI /** * @category zone of death * @since 2.0.0 * @deprecated */ export interface EitherT<M, E, A> extends HKT<M, Either<E, A>> {} /** * @category zone of death * @since 2.0.0 * @deprecated */ export interface EitherM<M> extends ApplicativeCompositionHKT2<M, URI> { readonly chain: <E, A, B>(ma: EitherT<M, E, A>, f: (a: A) => EitherT<M, E, B>) => EitherT<M, E, B> readonly alt: <E, A>(fa: EitherT<M, E, A>, that: LazyArg<EitherT<M, E, A>>) => EitherT<M, E, A> readonly bimap: <E, A, N, B>(ma: EitherT<M, E, A>, f: (e: E) => N, g: (a: A) => B) => EitherT<M, N, B> readonly mapLeft: <E, A, N>(ma: EitherT<M, E, A>, f: (e: E) => N) => EitherT<M, N, A> readonly fold: <E, A, R>(ma: EitherT<M, E, A>, onLeft: (e: E) => HKT<M, R>, onRight: (a: A) => HKT<M, R>) => HKT<M, R> readonly getOrElse: <E, A>(ma: EitherT<M, E, A>, onLeft: (e: E) => HKT<M, A>) => HKT<M, A> readonly orElse: <E, A, N>(ma: EitherT<M, E, A>, onLeft: (e: E) => EitherT<M, N, A>) => EitherT<M, N, A> readonly swap: <E, A>(ma: EitherT<M, E, A>) => EitherT<M, A, E> readonly rightM: <E, A>(ma: HKT<M, A>) => EitherT<M, E, A> readonly leftM: <E, A>(me: HKT<M, E>) => EitherT<M, E, A> readonly left: <E, A>(e: E) => EitherT<M, E, A> } /** * @category zone of death * @since 2.0.0 * @deprecated */ export type EitherT1<M extends URIS, E, A> = Kind<M, Either<E, A>> /** * @category zone of death * @since 2.0.0 * @deprecated */ export interface EitherM1<M extends URIS> extends ApplicativeComposition12<M, URI> { readonly chain: <E, A, B>(ma: EitherT1<M, E, A>, f: (a: A) => EitherT1<M, E, B>) => EitherT1<M, E, B> readonly alt: <E, A>(fa: EitherT1<M, E, A>, that: LazyArg<EitherT1<M, E, A>>) => EitherT1<M, E, A> readonly bimap: <E, A, N, B>(ma: EitherT1<M, E, A>, f: (e: E) => N, g: (a: A) => B) => EitherT1<M, N, B> readonly mapLeft: <E, A, N>(ma: EitherT1<M, E, A>, f: (e: E) => N) => EitherT1<M, N, A> readonly fold: <E, A, R>( ma: EitherT1<M, E, A>, onLeft: (e: E) => Kind<M, R>, onRight: (a: A) => Kind<M, R> ) => Kind<M, R> readonly getOrElse: <E, A>(ma: EitherT1<M, E, A>, onLeft: (e: E) => Kind<M, A>) => Kind<M, A> readonly orElse: <E, A, N>(ma: EitherT1<M, E, A>, onLeft: (e: E) => EitherT1<M, N, A>) => EitherT1<M, N, A> readonly swap: <E, A>(ma: EitherT1<M, E, A>) => EitherT1<M, A, E> readonly rightM: <E, A>(ma: Kind<M, A>) => EitherT1<M, E, A> readonly leftM: <E, A>(me: Kind<M, E>) => EitherT1<M, E, A> readonly left: <E, A>(e: E) => EitherT1<M, E, A> } /** * @category zone of death * @since 2.0.0 * @deprecated */ export type EitherT2<M extends URIS2, R, E, A> = Kind2<M, R, Either<E, A>> /** * @category zone of death * @since 2.0.0 * @deprecated */ export interface EitherM2<M extends URIS2> extends ApplicativeComposition22<M, URI> { readonly chain: <R, E, A, B>(ma: EitherT2<M, R, E, A>, f: (a: A) => EitherT2<M, R, E, B>) => EitherT2<M, R, E, B> readonly alt: <R, E, A>(fa: EitherT2<M, R, E, A>, that: LazyArg<EitherT2<M, R, E, A>>) => EitherT2<M, R, E, A> readonly bimap: <R, E, A, N, B>(ma: EitherT2<M, R, E, A>, f: (e: E) => N, g: (a: A) => B) => EitherT2<M, R, N, B> readonly mapLeft: <R, E, A, N>(ma: EitherT2<M, R, E, A>, f: (e: E) => N) => EitherT2<M, R, N, A> readonly fold: <R, E, A, B>( ma: EitherT2<M, R, E, A>, onLeft: (e: E) => Kind2<M, R, B>, onRight: (a: A) => Kind2<M, R, B> ) => Kind2<M, R, B> readonly getOrElse: <R, E, A>(ma: EitherT2<M, R, E, A>, onLeft: (e: E) => Kind2<M, R, A>) => Kind2<M, R, A> readonly orElse: <R, E, A, F>( ma: EitherT2<M, R, E, A>, onLeft: (e: E) => EitherT2<M, R, F, A> ) => EitherT2<M, R, F, A> readonly swap: <R, E, A>(ma: EitherT2<M, R, E, A>) => EitherT2<M, R, A, E> readonly rightM: <R, E, A>(ma: Kind2<M, R, A>) => EitherT2<M, R, E, A> readonly leftM: <R, E, A>(me: Kind2<M, R, E>) => EitherT2<M, R, E, A> readonly left: <R, E, A>(e: E) => EitherT2<M, R, E, A> } /** * @category zone of death * @since 2.0.0 * @deprecated */ export declare function getEitherM<M extends URIS2>(M: Monad2<M>): EitherM2<M> /** @deprecated */ export declare function getEitherM<M extends URIS>(M: Monad1<M>): EitherM1<M> /** @deprecated */ export declare function getEitherM<M>(M: Monad<M>): EitherM<M>