|
- /**
- * The reader monad transformer, which adds a read-only environment to the given monad.
- *
- * The `of` function ignores the environment, while `chain` passes the inherited environment to both subcomputations.
- *
- * @since 2.0.0
- */
- import { Apply, Apply1, Apply2, Apply2C, Apply3, Apply3C, Apply4 } from './Apply'
- import { Chain, Chain1, Chain2, Chain2C, Chain3, Chain3C, Chain4 } from './Chain'
- import { Functor, Functor1, Functor2, Functor2C, Functor3, Functor3C, Functor4 } from './Functor'
- import { HKT, Kind, Kind2, Kind3, Kind4, URIS, URIS2, URIS3, URIS4 } from './HKT'
- import { Monad, Monad1, Monad2, Monad2C, Monad3 } from './Monad'
- import {
- NaturalTransformation22,
- NaturalTransformation12,
- NaturalTransformation11,
- NaturalTransformation,
- NaturalTransformation23R,
- NaturalTransformation24S
- } from './NaturalTransformation'
- import { Pointed, Pointed1, Pointed2, Pointed2C, Pointed3, Pointed3C, Pointed4 } from './Pointed'
- import { Reader } from './Reader'
- /**
- * @since 2.10.0
- */
- export declare function of<F extends URIS4>(
- F: Pointed4<F>
- ): <A, R, S, FR, FE>(a: A) => Reader<R, Kind4<F, S, FR, FE, A>>
- export declare function of<F extends URIS3>(F: Pointed3<F>): <A, R, FR, FE>(a: A) => Reader<R, Kind3<F, FR, FE, A>>
- export declare function of<F extends URIS3, FE>(F: Pointed3C<F, FE>): <A, R, FR>(a: A) => Reader<R, Kind3<F, FR, FE, A>>
- export declare function of<F extends URIS2>(F: Pointed2<F>): <A, R, FE>(a: A) => Reader<R, Kind2<F, FE, A>>
- export declare function of<F extends URIS2, FE>(F: Pointed2C<F, FE>): <A, R>(a: A) => Reader<R, Kind2<F, FE, A>>
- export declare function of<F extends URIS>(F: Pointed1<F>): <A, R>(a: A) => Reader<R, Kind<F, A>>
- export declare function of<F>(F: Pointed<F>): <A, R>(a: A) => Reader<R, HKT<F, A>>
- /**
- * @since 2.10.0
- */
- export declare function map<F extends URIS4>(
- F: Functor4<F>
- ): <A, B>(f: (a: A) => B) => <R, S, FR, FE>(fa: Reader<R, Kind4<F, S, FR, FE, A>>) => Reader<R, Kind4<F, S, FR, FE, B>>
- export declare function map<F extends URIS3>(
- F: Functor3<F>
- ): <A, B>(f: (a: A) => B) => <R, FR, FE>(fa: Reader<R, Kind3<F, FR, FE, A>>) => Reader<R, Kind3<F, FR, FE, B>>
- export declare function map<F extends URIS3, FE>(
- F: Functor3C<F, FE>
- ): <A, B>(f: (a: A) => B) => <R, FR>(fa: Reader<R, Kind3<F, FR, FE, A>>) => Reader<R, Kind3<F, FR, FE, B>>
- export declare function map<F extends URIS2>(
- F: Functor2<F>
- ): <A, B>(f: (a: A) => B) => <R, FE>(fa: Reader<R, Kind2<F, FE, A>>) => Reader<R, Kind2<F, FE, B>>
- export declare function map<F extends URIS2, FE>(
- F: Functor2C<F, FE>
- ): <A, B>(f: (a: A) => B) => <R>(fa: Reader<R, Kind2<F, FE, A>>) => Reader<R, Kind2<F, FE, B>>
- export declare function map<F extends URIS>(
- F: Functor1<F>
- ): <A, B>(f: (a: A) => B) => <R>(fa: Reader<R, Kind<F, A>>) => Reader<R, Kind<F, B>>
- export declare function map<F>(
- F: Functor<F>
- ): <A, B>(f: (a: A) => B) => <R>(fa: Reader<R, HKT<F, A>>) => Reader<R, HKT<F, B>>
- /**
- * @since 2.10.0
- */
- export declare function ap<F extends URIS4>(
- F: Apply4<F>
- ): <R, S, FR, FE, A>(
- fa: Reader<R, Kind4<F, S, FR, FE, A>>
- ) => <B>(fab: Reader<R, Kind4<F, S, FR, FE, (a: A) => B>>) => Reader<R, Kind4<F, S, FR, FE, B>>
- export declare function ap<F extends URIS3>(
- F: Apply3<F>
- ): <R, FR, FE, A>(
- fa: Reader<R, Kind3<F, FR, FE, A>>
- ) => <B>(fab: Reader<R, Kind3<F, FR, FE, (a: A) => B>>) => Reader<R, Kind3<F, FR, FE, B>>
- export declare function ap<F extends URIS3, FE>(
- F: Apply3C<F, FE>
- ): <R, FR, A>(
- fa: Reader<R, Kind3<F, FR, FE, A>>
- ) => <B>(fab: Reader<R, Kind3<F, FR, FE, (a: A) => B>>) => Reader<R, Kind3<F, FR, FE, B>>
- export declare function ap<F extends URIS2>(
- F: Apply2<F>
- ): <R, FE, A>(
- fa: Reader<R, Kind2<F, FE, A>>
- ) => <B>(fab: Reader<R, Kind2<F, FE, (a: A) => B>>) => Reader<R, Kind2<F, FE, B>>
- export declare function ap<F extends URIS2, FE>(
- F: Apply2C<F, FE>
- ): <R, A>(
- fa: Reader<R, Kind2<F, FE, A>>
- ) => <B>(fab: Reader<R, Kind2<F, FE, (a: A) => B>>) => Reader<R, Kind2<F, FE, B>>
- export declare function ap<F extends URIS>(
- F: Apply1<F>
- ): <R, A>(fa: Reader<R, Kind<F, A>>) => <B>(fab: Reader<R, Kind<F, (a: A) => B>>) => Reader<R, Kind<F, B>>
- export declare function ap<F>(
- F: Apply<F>
- ): <R, A>(fa: Reader<R, HKT<F, A>>) => <B>(fab: Reader<R, HKT<F, (a: A) => B>>) => Reader<R, HKT<F, B>>
- /**
- * @since 2.10.0
- */
- export declare function chain<M extends URIS4>(
- M: Chain4<M>
- ): <A, R, S, FR, FE, B>(
- f: (a: A) => Reader<R, Kind4<M, S, FR, FE, B>>
- ) => (ma: Reader<R, Kind4<M, S, FR, FE, A>>) => Reader<R, Kind4<M, S, FR, FE, B>>
- export declare function chain<M extends URIS3>(
- M: Chain3<M>
- ): <A, R, FR, FE, B>(
- f: (a: A) => Reader<R, Kind3<M, FR, FE, B>>
- ) => (ma: Reader<R, Kind3<M, FR, FE, A>>) => Reader<R, Kind3<M, FR, FE, B>>
- export declare function chain<M extends URIS3, FE>(
- M: Chain3C<M, FE>
- ): <A, R, FR, B>(
- f: (a: A) => Reader<R, Kind3<M, FR, FE, B>>
- ) => (ma: Reader<R, Kind3<M, FR, FE, A>>) => Reader<R, Kind3<M, FR, FE, B>>
- export declare function chain<M extends URIS2>(
- M: Chain2<M>
- ): <A, R, FE, B>(
- f: (a: A) => Reader<R, Kind2<M, FE, B>>
- ) => (ma: Reader<R, Kind2<M, FE, A>>) => Reader<R, Kind2<M, FE, B>>
- export declare function chain<M extends URIS2, FE>(
- M: Chain2C<M, FE>
- ): <A, R, B>(f: (a: A) => Reader<R, Kind2<M, FE, B>>) => (ma: Reader<R, Kind2<M, FE, A>>) => Reader<R, Kind2<M, FE, B>>
- export declare function chain<M extends URIS>(
- M: Chain1<M>
- ): <A, R, B>(f: (a: A) => Reader<R, Kind<M, B>>) => (ma: Reader<R, Kind<M, A>>) => Reader<R, Kind<M, B>>
- export declare function chain<M>(
- M: Chain<M>
- ): <A, R, B>(f: (a: A) => Reader<R, HKT<M, B>>) => (ma: Reader<R, HKT<M, A>>) => Reader<R, HKT<M, B>>
- /**
- * @since 2.10.0
- */
- export declare function fromReader<F extends URIS4>(
- F: Pointed4<F>
- ): <R, A, S, FR, FE>(ma: Reader<R, A>) => Reader<R, Kind4<F, S, FR, FE, A>>
- export declare function fromReader<F extends URIS3>(
- F: Pointed3<F>
- ): <R, A, FR, FE>(ma: Reader<R, A>) => Reader<R, Kind3<F, FR, FE, A>>
- export declare function fromReader<F extends URIS3, FE>(
- F: Pointed3C<F, FE>
- ): <R, A, FR>(ma: Reader<R, A>) => Reader<R, Kind3<F, FR, FE, A>>
- export declare function fromReader<F extends URIS2>(
- F: Pointed2<F>
- ): <R, A, FE>(ma: Reader<R, A>) => Reader<R, Kind2<F, FE, A>>
- export declare function fromReader<F extends URIS2, FE>(
- F: Pointed2C<F, FE>
- ): <R, A>(ma: Reader<R, A>) => Reader<R, Kind2<F, FE, A>>
- export declare function fromReader<F extends URIS>(F: Pointed1<F>): <R, A>(ma: Reader<R, A>) => Reader<R, Kind<F, A>>
- export declare function fromReader<F>(F: Pointed<F>): <R, A>(ma: Reader<R, A>) => Reader<R, HKT<F, A>>
- /**
- * @category constructors
- * @since 2.11.0
- */
- export declare function fromNaturalTransformation<F extends URIS2, G extends URIS4>(
- nt: NaturalTransformation24S<F, G>
- ): <R, S, A, E>(f: (r: R) => Kind2<F, S, A>) => Reader<R, Kind4<G, S, R, E, A>>
- export declare function fromNaturalTransformation<F extends URIS2, G extends URIS3>(
- nt: NaturalTransformation23R<F, G>
- ): <R, A, E>(f: (r: R) => Kind2<F, R, A>) => Reader<R, Kind3<G, R, E, A>>
- export declare function fromNaturalTransformation<F extends URIS2, G extends URIS2>(
- nt: NaturalTransformation22<F, G>
- ): <R, E, A>(f: (r: R) => Kind2<F, E, A>) => Reader<R, Kind2<G, E, A>>
- export declare function fromNaturalTransformation<F extends URIS, G extends URIS2>(
- nt: NaturalTransformation12<F, G>
- ): <R, A, E>(f: (r: R) => Kind<F, A>) => Reader<R, Kind2<G, E, A>>
- export declare function fromNaturalTransformation<F extends URIS, G extends URIS>(
- nt: NaturalTransformation11<F, G>
- ): <R, A>(f: (r: R) => Kind<F, A>) => Reader<R, Kind<G, A>>
- export declare function fromNaturalTransformation<F, G>(
- nt: NaturalTransformation<F, G>
- ): <R, A>(f: (r: R) => HKT<F, A>) => Reader<R, HKT<G, A>>
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderT<M, R, A> {
- (r: R): HKT<M, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderM<M> {
- readonly map: <R, A, B>(ma: ReaderT<M, R, A>, f: (a: A) => B) => ReaderT<M, R, B>
- readonly of: <R, A>(a: A) => ReaderT<M, R, A>
- readonly ap: <R, A, B>(mab: ReaderT<M, R, (a: A) => B>, ma: ReaderT<M, R, A>) => ReaderT<M, R, B>
- readonly chain: <R, A, B>(ma: ReaderT<M, R, A>, f: (a: A) => ReaderT<M, R, B>) => ReaderT<M, R, B>
- readonly ask: <R>() => ReaderT<M, R, R>
- readonly asks: <R, A>(f: (r: R) => A) => ReaderT<M, R, A>
- readonly local: <R1, A, R2>(ma: ReaderT<M, R1, A>, f: (d: R2) => R1) => ReaderT<M, R2, A>
- readonly fromReader: <R, A>(ma: Reader<R, A>) => ReaderT<M, R, A>
- readonly fromM: <R, A>(ma: HKT<M, A>) => ReaderT<M, R, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderT1<M extends URIS, R, A> {
- (r: R): Kind<M, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderM1<M extends URIS> {
- readonly map: <R, A, B>(ma: ReaderT1<M, R, A>, f: (a: A) => B) => ReaderT1<M, R, B>
- readonly of: <R, A>(a: A) => ReaderT1<M, R, A>
- readonly ap: <R, A, B>(mab: ReaderT1<M, R, (a: A) => B>, ma: ReaderT1<M, R, A>) => ReaderT1<M, R, B>
- readonly chain: <R, A, B>(ma: ReaderT1<M, R, A>, f: (a: A) => ReaderT1<M, R, B>) => ReaderT1<M, R, B>
- readonly ask: <R>() => ReaderT1<M, R, R>
- readonly asks: <R, A>(f: (r: R) => A) => ReaderT1<M, R, A>
- readonly local: <R1, A, R2>(ma: ReaderT1<M, R1, A>, f: (d: R2) => R1) => ReaderT1<M, R2, A>
- readonly fromReader: <R, A>(ma: Reader<R, A>) => ReaderT1<M, R, A>
- readonly fromM: <R, A>(ma: Kind<M, A>) => ReaderT1<M, R, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderT2<M extends URIS2, R, E, A> {
- (r: R): Kind2<M, E, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderM2<M extends URIS2> {
- readonly map: <R, E, A, B>(ma: ReaderT2<M, R, E, A>, f: (a: A) => B) => ReaderT2<M, R, E, B>
- readonly of: <R, E, A>(a: A) => ReaderT2<M, R, E, A>
- readonly ap: <R, E, A, B>(mab: ReaderT2<M, R, E, (a: A) => B>, ma: ReaderT2<M, R, E, A>) => ReaderT2<M, R, E, B>
- readonly chain: <R, E, A, B>(ma: ReaderT2<M, R, E, A>, f: (a: A) => ReaderT2<M, R, E, B>) => ReaderT2<M, R, E, B>
- readonly ask: <R, E>() => ReaderT2<M, R, E, R>
- readonly asks: <R, E, A>(f: (r: R) => A) => ReaderT2<M, R, E, A>
- readonly local: <R1, E, A, R2>(ma: ReaderT2<M, R1, E, A>, f: (d: R2) => R1) => ReaderT2<M, R2, E, A>
- readonly fromReader: <R, E, A>(ma: Reader<R, A>) => ReaderT2<M, R, E, A>
- readonly fromM: <R, E, A>(ma: Kind2<M, E, A>) => ReaderT2<M, R, E, A>
- }
- /**
- * @category zone of death
- * @since 2.2.0
- * @deprecated
- */
- export interface ReaderM2C<M extends URIS2, E> {
- readonly map: <R, A, B>(ma: ReaderT2<M, R, E, A>, f: (a: A) => B) => ReaderT2<M, R, E, B>
- readonly of: <R, A>(a: A) => ReaderT2<M, R, E, A>
- readonly ap: <R, A, B>(mab: ReaderT2<M, R, E, (a: A) => B>, ma: ReaderT2<M, R, E, A>) => ReaderT2<M, R, E, B>
- readonly chain: <R, A, B>(ma: ReaderT2<M, R, E, A>, f: (a: A) => ReaderT2<M, R, E, B>) => ReaderT2<M, R, E, B>
- readonly ask: <R>() => ReaderT2<M, R, E, R>
- readonly asks: <R, A>(f: (r: R) => A) => ReaderT2<M, R, E, A>
- readonly local: <R1, A, R2>(ma: ReaderT2<M, R1, E, A>, f: (d: R2) => R1) => ReaderT2<M, R2, E, A>
- readonly fromReader: <R, A>(ma: Reader<R, A>) => ReaderT2<M, R, E, A>
- readonly fromM: <R, A>(ma: Kind2<M, E, A>) => ReaderT2<M, R, E, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderT3<M extends URIS3, R, U, E, A> {
- (r: R): Kind3<M, U, E, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export interface ReaderM3<M extends URIS3> {
- readonly map: <R, U, E, A, B>(ma: ReaderT3<M, R, U, E, A>, f: (a: A) => B) => ReaderT3<M, R, U, E, B>
- readonly of: <R, U, E, A>(a: A) => ReaderT3<M, R, U, E, A>
- readonly ap: <R, U, E, A, B>(
- mab: ReaderT3<M, R, U, E, (a: A) => B>,
- ma: ReaderT3<M, R, U, E, A>
- ) => ReaderT3<M, R, U, E, B>
- readonly chain: <R, U, E, A, B>(
- ma: ReaderT3<M, R, U, E, A>,
- f: (a: A) => ReaderT3<M, R, U, E, B>
- ) => ReaderT3<M, R, U, E, B>
- readonly ask: <R, U, E>() => ReaderT3<M, R, U, E, R>
- readonly asks: <R, U, E, A>(f: (r: R) => A) => ReaderT3<M, R, U, E, A>
- readonly local: <R1, U, E, A, R2>(ma: ReaderT3<M, R1, U, E, A>, f: (d: R2) => R1) => ReaderT3<M, R2, U, E, A>
- readonly fromReader: <R, U, E, A>(ma: Reader<R, A>) => ReaderT3<M, R, U, E, A>
- readonly fromM: <R, U, E, A>(ma: Kind3<M, U, E, A>) => ReaderT3<M, R, U, E, A>
- }
- /**
- * @category zone of death
- * @since 2.0.0
- * @deprecated
- */
- export declare function getReaderM<M extends URIS3>(M: Monad3<M>): ReaderM3<M>
- /** @deprecated */
- export declare function getReaderM<M extends URIS2>(M: Monad2<M>): ReaderM2<M>
- /** @deprecated */
- export declare function getReaderM<M extends URIS2, E>(M: Monad2C<M, E>): ReaderM2C<M, E>
- /** @deprecated */
- export declare function getReaderM<M extends URIS>(M: Monad1<M>): ReaderM1<M>
- /** @deprecated */
- export declare function getReaderM<M>(M: Monad<M>): ReaderM<M>
|