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: () => ReaderTaskEither<R, E, A>
) => (fa: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Less strict version of alt
.
Signature
export declare const altW: <R2, E2, B>(
that: () => ReaderTaskEither<R2, E2, B>
) => <R1, E1, A>(fa: ReaderTaskEither<R1, E1, A>) => ReaderTaskEither<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) => ReaderTaskEither<R, E, A>
Added in v2.7.0
Apply a function to an argument under a type constructor.
Signature
export declare const ap: <R, E, A>(
fa: ReaderTaskEither<R, E, A>
) => <B>(fab: ReaderTaskEither<R, E, (a: A) => B>) => ReaderTaskEither<R, E, B>
Added in v2.0.0
Less strict version of ap
.
Signature
export declare const apW: <Q, D, A>(
fa: ReaderTaskEither<Q, D, A>
) => <R, E, B>(fab: ReaderTaskEither<R, E, (a: A) => B>) => ReaderTaskEither<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: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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) => ReaderTaskEither<R, E, B>
) => (ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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) => ReaderTaskEither<R, E, B>
) => <Q, D>(ma: ReaderTaskEither<Q, D, A>) => ReaderTaskEither<Q & R, E | D, B>
Added in v2.6.0
Signature
export declare const fromIO: <R, E, A>(fa: IO<A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const fromTask: <R, E, A>(fa: T.Task<A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const throwError: <R, E, A>(e: E) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Combine two effectful actions, keeping only the result of the first.
Derivable from Apply
.
Signature
export declare const apFirst: <R, E, B>(
fb: ReaderTaskEither<R, E, B>
) => <A>(fa: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, E, B>
) => <A>(fa: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, D, A>) => ReaderTaskEither<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) => ReaderTaskEither<R, E, B>
) => (ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Less strict version of chainFirst
.
Derivable from Monad
.
Signature
export declare const chainFirstW: <R, E, A, B>(
f: (a: A) => ReaderTaskEither<R, E, B>
) => <Q, D>(ma: ReaderTaskEither<Q, D, A>) => ReaderTaskEither<Q & R, E | D, A>
Added in v2.8.0
Signature
export declare const chainIOEitherK: <E, A, B>(
f: (a: A) => IOEither<E, B>
) => <R>(ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, E, B>
Added in v2.4.0
Less strict version of chainIOEitherK
.
Signature
export declare const chainIOEitherKW: <E, A, B>(
f: (a: A) => IOEither<E, B>
) => <R, D>(ma: ReaderTaskEither<R, D, A>) => ReaderTaskEither<R, E | D, B>
Added in v2.6.1
Signature
export declare const chainTaskEitherK: <E, A, B>(
f: (a: A) => TE.TaskEither<E, B>
) => <R>(ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, E, B>
Added in v2.4.0
Less strict version of chainTaskEitherK
.
Signature
export declare const chainTaskEitherKW: <E, A, B>(
f: (a: A) => TE.TaskEither<E, B>
) => <R, D>(ma: ReaderTaskEither<R, D, A>) => ReaderTaskEither<R, E | D, B>
Added in v2.6.1
Derivable from MonadThrow
.
Signature
export declare const filterOrElse: {
<E, A, B extends A>(refinement: Refinement<A, B>, onFalse: (a: A) => E): <R>(
ma: ReaderTaskEither<R, E, A>
) => ReaderTaskEither<R, E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): <R>(ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, E, A>
}
Added in v2.0.0
Derivable from Monad
.
Signature
export declare const flatten: <R, E, A>(
mma: ReaderTaskEither<R, E, ReaderTaskEither<R, E, A>>
) => ReaderTaskEither<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) => ReaderTaskEither<R, E, B>
Added in v2.4.0
Signature
export declare function fromIOEitherK<E, A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => IOEither<E, B>
): <R>(...a: A) => ReaderTaskEither<R, E, B>
Added in v2.4.0
Signature
export declare function fromTaskEitherK<E, A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => TaskEither<E, B>
): <R>(...a: A) => ReaderTaskEither<R, E, B>
Added in v2.4.0
Signature
export declare const local: <Q, R>(f: (f: Q) => R) => <E, A>(ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<Q, E, A>
Added in v2.0.0
Signature
export declare function orElse<R, E, A, M>(
onLeft: (e: E) => ReaderTaskEither<R, M, A>
): (ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, M, A>
Added in v2.0.0
Signature
export declare const swap: <R, E, A>(ma: ReaderTaskEither<R, E, A>) => ReaderTaskEither<R, A, E>
Added in v2.0.0
Signature
export declare const ask: <R, E = never>() => ReaderTaskEither<R, E, R>
Added in v2.0.0
Signature
export declare const asks: <R, E = never, A = never>(f: (r: R) => A) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Derivable from MonadThrow
.
Signature
export declare const fromEither: <R, E, A>(ma: E.Either<E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const fromIOEither: <R, E, A>(ma: IOEither<E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Derivable from MonadThrow
.
Signature
export declare const fromOption: <E>(onNone: Lazy<E>) => <R, A>(ma: Option<A>) => ReaderTaskEither<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) => ReaderTaskEither<U, E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): <R>(a: A) => ReaderTaskEither<R, E, A>
}
Added in v2.0.0
Signature
export declare const fromReaderEither: <R, E, A>(ma: ReaderEither<R, E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const fromTaskEither: <R, E, A>(ma: TE.TaskEither<E, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const left: <R, E = never, A = never>(e: E) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const leftIO: <R, E = never, A = never>(me: IO<E>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const leftReader: <R, E = never, A = never>(me: R.Reader<R, E>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const leftReaderTask: <R, E = never, A = never>(me: RT.ReaderTask<R, E>) => ReaderTaskEither<R, E, A>
Added in v2.5.0
Signature
export declare const leftTask: <R, E = never, A = never>(me: T.Task<E>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const right: <R, E = never, A = never>(a: A) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const rightIO: <R, E = never, A = never>(ma: IO<A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const rightReader: <R, E = never, A = never>(ma: R.Reader<R, A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare const rightReaderTask: <R, E = never, A = never>(ma: RT.ReaderTask<R, A>) => ReaderTaskEither<R, E, A>
Added in v2.5.0
Signature
export declare const rightTask: <R, E = never, A = never>(ma: T.Task<A>) => ReaderTaskEither<R, E, A>
Added in v2.0.0
Signature
export declare function fold<R, E, A, B>(
onLeft: (e: E) => ReaderTask<R, B>,
onRight: (a: A) => ReaderTask<R, B>
): (ma: ReaderTaskEither<R, E, A>) => ReaderTask<R, B>
Added in v2.0.0
Signature
export declare const getOrElse: <R, E, A>(
onLeft: (e: E) => RT.ReaderTask<R, A>
) => (ma: ReaderTaskEither<R, E, A>) => RT.ReaderTask<R, A>
Added in v2.0.0
Less strict version of getOrElse
.
Signature
export declare const getOrElseW: <R, E, B>(
onLeft: (e: E) => RT.ReaderTask<R, B>
) => <Q, A>(ma: ReaderTaskEither<Q, E, A>) => RT.ReaderTask<Q & R, B | A>
Added in v2.6.0
Signature
export declare const Alt: Alt3<'ReaderTaskEither'>
Added in v2.7.0
Signature
export declare const ApplicativePar: Applicative3<'ReaderTaskEither'>
Added in v2.7.0
Signature
export declare const ApplicativeSeq: Applicative3<'ReaderTaskEither'>
Added in v2.7.0
Signature
export declare const Bifunctor: Bifunctor3<'ReaderTaskEither'>
Added in v2.7.0
Signature
export declare const Functor: Functor3<'ReaderTaskEither'>
Added in v2.7.0
Signature
export declare const URI: 'ReaderTaskEither'
Added in v2.0.0
Signature
export type URI = typeof URI
Added in v2.0.0
Signature
export declare function getAltReaderTaskValidation<E>(SE: Semigroup<E>): Alt3C<URI, E>
Added in v2.7.0
Signature
export declare function getApplicativeReaderTaskValidation<E>(A: Apply1<T.URI>, SE: Semigroup<E>): Applicative3C<URI, E>
Added in v2.7.0
Signature
export declare function getApplyMonoid<R, E, A>(M: Monoid<A>): Monoid<ReaderTaskEither<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<ReaderTaskEither<R, E, A>>
Added in v2.0.0
Signature
export declare function getReaderTaskValidation<E>(
SE: Semigroup<E>
): Monad3C<URI, E> & Bifunctor3<URI> & Alt3C<URI, E> & MonadTask3C<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<ReaderTaskEither<R, E, A>>
Added in v2.0.0
Signature
export declare const readerTaskEither: Monad3<'ReaderTaskEither'> &
Bifunctor3<'ReaderTaskEither'> &
Alt3<'ReaderTaskEither'> &
MonadTask3<'ReaderTaskEither'> &
MonadThrow3<'ReaderTaskEither'>
Added in v2.0.0
Like readerTaskEither
but ap
is sequential
Signature
export declare const readerTaskEitherSeq: Monad3<'ReaderTaskEither'> &
Bifunctor3<'ReaderTaskEither'> &
Alt3<'ReaderTaskEither'> &
MonadTask3<'ReaderTaskEither'> &
MonadThrow3<'ReaderTaskEither'>
Added in v2.0.0
Signature
export interface ReaderTaskEither<R, E, A> {
(r: R): TaskEither<E, A>
}
Added in v2.0.0
Signature
export declare const Do: ReaderTaskEither<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: ReaderTaskEither<R, E, B>
) => (fa: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<Q, D, B>
) => <R, E>(
fa: ReaderTaskEither<R, E, A>
) => ReaderTaskEither<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) => ReaderTaskEither<R, E, B>
) => (fa: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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: ReaderTaskEither<R, E, A>) => ReaderTaskEither<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) => ReaderTaskEither<Q, D, B>
) => <R, E>(
fa: ReaderTaskEither<R, E, A>
) => ReaderTaskEither<Q & R, D | E, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Make sure that a resource is cleaned up in the event of an exception (*). The release action is called regardless of whether the body action throws (*) or returns.
(*) i.e. returns a Left
Derivable from MonadThrow
.
Signature
export declare function bracket<R, E, A, B>(
aquire: ReaderTaskEither<R, E, A>,
use: (a: A) => ReaderTaskEither<R, E, B>,
release: (a: A, e: Either<E, B>) => ReaderTaskEither<R, E, void>
): ReaderTaskEither<R, E, B>
Added in v2.0.4
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: ReaderTaskEither<R, E1, A>
) => ReaderTaskEither<R, E2 | E1, B>
<A, E2>(predicate: Predicate<A>, onFalse: (a: A) => E2): <R, E1>(
ma: ReaderTaskEither<R, E1, A>
) => ReaderTaskEither<R, E2 | E1, A>
}
Added in v2.9.0
Signature
export declare function run<R, E, A>(ma: ReaderTaskEither<R, E, A>, r: R): Promise<Either<E, A>>
Added in v2.0.0
Signature
export declare const sequenceArray: <R, E, A>(
arr: readonly ReaderTaskEither<R, E, A>[]
) => ReaderTaskEither<R, E, readonly A[]>
Added in v2.9.0
Signature
export declare const sequenceSeqArray: <R, E, A>(
arr: readonly ReaderTaskEither<R, E, A>[]
) => ReaderTaskEither<R, E, readonly A[]>
Added in v2.9.0
Signature
export declare const traverseArray: <R, E, A, B>(
f: (a: A) => ReaderTaskEither<R, E, B>
) => (arr: readonly A[]) => ReaderTaskEither<R, E, readonly B[]>
Added in v2.9.0
Signature
export declare const traverseArrayWithIndex: <R, E, A, B>(
f: (index: number, a: A) => ReaderTaskEither<R, E, B>
) => (arr: readonly A[]) => ReaderTaskEither<R, E, readonly B[]>
Added in v2.9.0
Signature
export declare const traverseSeqArray: <R, E, A, B>(
f: (a: A) => ReaderTaskEither<R, E, B>
) => (arr: readonly A[]) => ReaderTaskEither<R, E, readonly B[]>
Added in v2.9.0
Signature
export declare const traverseSeqArrayWithIndex: <R, E, A, B>(
f: (index: number, a: A) => ReaderTaskEither<R, E, B>
) => (arr: readonly A[]) => ReaderTaskEither<R, E, readonly B[]>
Added in v2.9.0