Added in v2.0.0
Identifies an associative operation on a type constructor. It is similar to Semigroup
, except that it applies to
types of kind * -> *
.
Signature
export declare const alt: <R, E, A>(
that: () => ReaderEither<R, E, A>
) => (fa: ReaderEither<R, E, A>) => ReaderEither<R, E, A>
Added in v2.0.0
Less strict version of alt
.
Signature
export declare const altW: <R2, E2, B>(
that: () => ReaderEither<R2, E2, B>
) => <R1, E1, A>(fa: ReaderEither<R1, E1, A>) => ReaderEither<R1 & R2, E2 | E1, B | A>
Added in v2.9.0
Wrap a value into the type constructor.
Equivalent to right
.
Signature
export declare const of: <R, E, A>(a: A) => ReaderEither<R, E, A>
Added in v2.8.5
Apply a function to an argument under a type constructor.
Signature
export declare const ap: <R, E, A>(
fa: ReaderEither<R, E, A>
) => <B>(fab: ReaderEither<R, E, (a: A) => B>) => ReaderEither<R, E, B>
Added in v2.0.0
Less strict version of ap
.
Signature
export declare const apW: <Q, D, A>(
fa: ReaderEither<Q, D, A>
) => <R, E, B>(fab: ReaderEither<R, E, (a: A) => B>) => ReaderEither<Q & R, D | E, B>
Added in v2.8.0
Map a pair of functions over the two last type arguments of the bifunctor.
Signature
export declare const bimap: <E, G, A, B>(
f: (e: E) => G,
g: (a: A) => B
) => <R>(fa: ReaderEither<R, E, A>) => ReaderEither<R, G, B>
Added in v2.0.0
Map a function over the second type argument of a bifunctor.
Signature
export declare const mapLeft: <E, G>(f: (e: E) => G) => <R, A>(fa: ReaderEither<R, E, A>) => ReaderEither<R, G, A>
Added in v2.0.0
map
can be used to turn functions (a: A) => B
into functions (fa: F<A>) => F<B>
whose argument and return types
use the type constructor F
to represent some computational context.
Signature
export declare const map: <A, B>(f: (a: A) => B) => <R, E>(fa: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
Added in v2.0.0
Composes computations in sequence, using the return value of one computation to determine the next computation.
Signature
export declare const chain: <R, E, A, B>(
f: (a: A) => ReaderEither<R, E, B>
) => (ma: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
Added in v2.0.0
Less strict version of chain
.
Signature
export declare const chainW: <R, E, A, B>(
f: (a: A) => ReaderEither<R, E, B>
) => <Q, D>(ma: ReaderEither<Q, D, A>) => ReaderEither<Q & R, E | D, B>
Added in v2.6.0
Signature
export declare const throwError: <R, E, A>(e: E) => ReaderEither<R, E, A>
Added in v2.7.0
Combine two effectful actions, keeping only the result of the first.
Derivable from Apply
.
Signature
export declare const apFirst: <R, E, B>(
fb: ReaderEither<R, E, B>
) => <A>(fa: ReaderEither<R, E, A>) => ReaderEither<R, E, A>
Added in v2.0.0
Combine two effectful actions, keeping only the result of the second.
Derivable from Apply
.
Signature
export declare const apSecond: <R, E, B>(
fb: ReaderEither<R, E, B>
) => <A>(fa: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
Added in v2.0.0
Signature
export declare const chainEitherK: <E, A, B>(
f: (a: A) => E.Either<E, B>
) => <R>(ma: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
Added in v2.4.0
Less strict version of chainEitherK
.
Signature
export declare const chainEitherKW: <E, A, B>(
f: (a: A) => E.Either<E, B>
) => <R, D>(ma: ReaderEither<R, D, A>) => ReaderEither<R, E | D, B>
Added in v2.6.1
Composes computations in sequence, using the return value of one computation to determine the next computation and keeping only the result of the first.
Derivable from Monad
.
Signature
export declare const chainFirst: <R, E, A, B>(
f: (a: A) => ReaderEither<R, E, B>
) => (ma: ReaderEither<R, E, A>) => ReaderEither<R, E, A>
Added in v2.0.0
Less strict version of chainFirst
Derivable from Monad
.
Signature
export declare const chainFirstW: <R, D, A, B>(
f: (a: A) => ReaderEither<R, D, B>
) => <Q, E>(ma: ReaderEither<Q, E, A>) => ReaderEither<Q & R, D | E, A>
Added in v2.8.0
Derivable from MonadThrow
.
Signature
export declare const filterOrElse: {
<E, A, B extends A>(refinement: Refinement<A, B>, onFalse: (a: A) => E): <R>(
ma: ReaderEither<R, E, A>
) => ReaderEither<R, E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): <R>(ma: ReaderEither<R, E, A>) => ReaderEither<R, E, A>
}
Added in v2.0.0
Derivable from Monad
.
Signature
export declare const flatten: <R, E, A>(mma: ReaderEither<R, E, ReaderEither<R, E, A>>) => ReaderEither<R, E, A>
Added in v2.0.0
Signature
export declare function fromEitherK<E, A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => Either<E, B>
): <R>(...a: A) => ReaderEither<R, E, B>
Added in v2.4.0
Signature
export declare function local<Q, R>(f: (f: Q) => R): <E, A>(ma: ReaderEither<R, E, A>) => ReaderEither<Q, E, A>
Added in v2.0.0
Signature
export declare const orElse: <E, R, M, A>(
onLeft: (e: E) => ReaderEither<R, M, A>
) => (ma: ReaderEither<R, E, A>) => ReaderEither<R, M, A>
Added in v2.0.0
Signature
export declare const swap: <R, E, A>(ma: ReaderEither<R, E, A>) => ReaderEither<R, A, E>
Added in v2.0.0
Signature
export declare const ask: <R, E = never>() => ReaderEither<R, E, R>
Added in v2.0.0
Signature
export declare const asks: <R, E = never, A = never>(f: (r: R) => A) => ReaderEither<R, E, A>
Added in v2.0.0
Derivable from MonadThrow
.
Signature
export declare const fromEither: <R, E, A>(ma: E.Either<E, A>) => ReaderEither<R, E, A>
Added in v2.0.0
Derivable from MonadThrow
.
Signature
export declare const fromOption: <E>(onNone: () => E) => <R, A>(ma: Option<A>) => ReaderEither<R, E, A>
Added in v2.0.0
Derivable from MonadThrow
.
Signature
export declare const fromPredicate: {
<E, A, B extends A>(refinement: Refinement<A, B>, onFalse: (a: A) => E): <U>(a: A) => ReaderEither<U, E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): <R>(a: A) => ReaderEither<R, E, A>
}
Added in v2.0.0
Signature
export declare const left: <R, E = never, A = never>(e: E) => ReaderEither<R, E, A>
Added in v2.0.0
Signature
export declare const leftReader: <R, E = never, A = never>(me: R.Reader<R, E>) => ReaderEither<R, E, A>
Added in v2.0.0
Signature
export declare const right: <R, E = never, A = never>(a: A) => ReaderEither<R, E, A>
Added in v2.0.0
Signature
export declare const rightReader: <R, E = never, A = never>(ma: R.Reader<R, A>) => ReaderEither<R, E, A>
Added in v2.0.0
Signature
export declare const fold: <R, E, A, B>(
onLeft: (e: E) => R.Reader<R, B>,
onRight: (a: A) => R.Reader<R, B>
) => (ma: ReaderEither<R, E, A>) => R.Reader<R, B>
Added in v2.0.0
Signature
export declare const getOrElse: <E, R, A>(
onLeft: (e: E) => R.Reader<R, A>
) => (ma: ReaderEither<R, E, A>) => R.Reader<R, A>
Added in v2.0.0
Less strict version of getOrElse
.
Signature
export declare const getOrElseW: <R, E, B>(
onLeft: (e: E) => R.Reader<R, B>
) => <Q, A>(ma: ReaderEither<Q, E, A>) => R.Reader<Q & R, B | A>
Added in v2.6.0
Signature
export declare const Alt: Alt3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const Applicative: Applicative3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const Bifunctor: Bifunctor3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const Functor: Functor3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const Monad: Monad3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const MonadThrow: MonadThrow3<'ReaderEither'>
Added in v2.7.0
Signature
export declare const URI: 'ReaderEither'
Added in v2.0.0
Signature
export type URI = typeof URI
Added in v2.0.0
Signature
export declare function getAltReaderValidation<E>(SE: Semigroup<E>): Alt3C<URI, E>
Added in v2.7.0
Signature
export declare function getApplicativeReaderValidation<E>(SE: Semigroup<E>): Applicative3C<URI, E>
Added in v2.7.0
Signature
export declare function getApplyMonoid<R, E, A>(M: Monoid<A>): Monoid<ReaderEither<R, E, A>>
Added in v2.0.0
Semigroup returning the left-most Left
value. If both operands are Right
s then the inner values
are concatenated using the provided Semigroup
Signature
export declare function getApplySemigroup<R, E, A>(S: Semigroup<A>): Semigroup<ReaderEither<R, E, A>>
Added in v2.0.0
Signature
export declare function getReaderValidation<E>(
SE: Semigroup<E>
): Monad3C<URI, E> & Bifunctor3<URI> & Alt3C<URI, E> & MonadThrow3C<URI, E>
Added in v2.3.0
Semigroup returning the left-most non-Left
value. If both operands are Right
s then the inner values are
concatenated using the provided Semigroup
Signature
export declare function getSemigroup<R, E, A>(S: Semigroup<A>): Semigroup<ReaderEither<R, E, A>>
Added in v2.0.0
Signature
export declare const readerEither: Monad3<'ReaderEither'> &
Bifunctor3<'ReaderEither'> &
Alt3<'ReaderEither'> &
MonadThrow3<'ReaderEither'>
Added in v2.0.0
Signature
export interface ReaderEither<R, E, A> extends Reader<R, Either<E, A>> {}
Added in v2.0.0
Signature
export declare const Do: ReaderEither<unknown, never, {}>
Added in v2.9.0
Signature
export declare const apS: <A, N extends string, R, E, B>(
name: Exclude<N, keyof A>,
fb: ReaderEither<R, E, B>
) => (fa: ReaderEither<R, E, A>) => ReaderEither<R, E, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Signature
export declare const apSW: <A, N extends string, Q, D, B>(
name: Exclude<N, keyof A>,
fb: ReaderEither<Q, D, B>
) => <R, E>(
fa: ReaderEither<R, E, A>
) => ReaderEither<Q & R, D | E, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Signature
export declare const bind: <N extends string, A, R, E, B>(
name: Exclude<N, keyof A>,
f: (a: A) => ReaderEither<R, E, B>
) => (fa: ReaderEither<R, E, A>) => ReaderEither<R, E, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Signature
export declare const bindTo: <N extends string>(
name: N
) => <R, E, A>(fa: ReaderEither<R, E, A>) => ReaderEither<R, E, { [K in N]: A }>
Added in v2.8.0
Signature
export declare const bindW: <N extends string, A, Q, D, B>(
name: Exclude<N, keyof A>,
f: (a: A) => ReaderEither<Q, D, B>
) => <R, E>(
fa: ReaderEither<R, E, A>
) => ReaderEither<Q & R, D | E, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Less strict version of filterOrElse
.
Signature
export declare const filterOrElseW: {
<A, B extends A, E2>(refinement: Refinement<A, B>, onFalse: (a: A) => E2): <R, E1>(
ma: ReaderEither<R, E1, A>
) => ReaderEither<R, E2 | E1, B>
<A, E2>(predicate: Predicate<A>, onFalse: (a: A) => E2): <R, E1>(
ma: ReaderEither<R, E1, A>
) => ReaderEither<R, E2 | E1, A>
}
Added in v2.9.0
Signature
export declare const sequenceArray: <R, E, A>(arr: readonly ReaderEither<R, E, A>[]) => ReaderEither<R, E, readonly A[]>
Added in v2.9.0
Signature
export declare const traverseArray: <R, E, A, B>(
f: (a: A) => ReaderEither<R, E, B>
) => (arr: readonly A[]) => ReaderEither<R, E, readonly B[]>
Added in v2.9.0
Signature
export declare const traverseArrayWithIndex: <R, E, A, B>(
f: (index: number, a: A) => ReaderEither<R, E, B>
) => (arr: readonly A[]) => ReaderEither<R, E, readonly B[]>
Added in v2.9.0