@typed/fp
Version:
Data Structures and Resources for fp-ts
403 lines • 13.1 kB
TypeScript
/**
* StateEnvEither is a StateT of EnvEither. Resume-based altenative to
* StateReaderTaskEither that support cancelation.
* @since 0.9.2
*/
import { Applicative4 } from 'fp-ts/Applicative';
import { Apply4 } from 'fp-ts/Apply';
import { Chain4 } from 'fp-ts/Chain';
import { ChainRec4 } from 'fp-ts/ChainRec';
import * as E from 'fp-ts/Either';
import { FromEither4 } from 'fp-ts/FromEither';
import { FromIO4 } from 'fp-ts/FromIO';
import { FromReader4 } from 'fp-ts/FromReader';
import { FromState4 } from 'fp-ts/FromState';
import { FromTask4 } from 'fp-ts/FromTask';
import { Functor4 } from 'fp-ts/Functor';
import { IO } from 'fp-ts/IO';
import { Monad4 } from 'fp-ts/Monad';
import { Pointed4 } from 'fp-ts/Pointed';
import * as ST from 'fp-ts/StateT';
import { Task } from 'fp-ts/Task';
import { Env } from './Env';
import * as EE from './EnvEither';
import { FromEnv4 } from './FromEnv';
import { FromResume4 } from './FromResume';
import { MonadRec4 } from './MonadRec';
import { Provide4, ProvideAll4, ProvideSome4, UseAll4, UseSome4 } from './Provide';
import { Reader } from './Reader';
import * as R from './Resume';
/**
* @since 0.9.2
* @category Model
*/
export interface StateEnvEither<S, R, E, A> {
(state: S): EE.EnvEither<R, E, readonly [value: A, nextState: S]>;
}
/**
* @since 0.9.2
* @category Combinator
*/
export declare const ap: <S, R, E, A>(fa: ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>) => <B>(fab: ST.StateT3<"@typed/fp/EnvEither", S, R, E, (a: A) => B>) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chain: <A, S, R, E, B>(f: (a: A) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, B>) => (ma: ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const evaluate: <S>(s: S) => <R, E, A>(ma: ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>) => EE.EnvEither<R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const execute: <S>(s: S) => <R, E, A>(ma: ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>) => EE.EnvEither<R, E, S>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromEnvEither: <R, E, A, S>(ma: EE.EnvEither<R, E, A>) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromState: <S, A, R, E>(sa: import("fp-ts/State").State<S, A>) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const map: <A, B>(f: (a: A) => B) => <S, R, E>(fa: ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const of: <A, S, R, E>(a: A) => ST.StateT3<"@typed/fp/EnvEither", S, R, E, A>;
/**
* @since 0.9.2
* @category URI
*/
export declare const URI = "@typed/fp/StateEnvEither";
/**
* @since 0.9.2
* @category URI
*/
export declare type URI = typeof URI;
declare module 'fp-ts/HKT' {
interface URItoKind4<S, R, E, A> {
[URI]: StateEnvEither<S, R, E, A>;
}
}
declare module './HKT' {
interface URItoVariance {
[URI]: V<R, Contravariant> & V<E, Covariant>;
}
}
/**
* @since 0.9.2
* @category Instance
*/
export declare const Pointed: Pointed4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Functor: Functor4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Apply: Apply4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Applicative: Applicative4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Chain: Chain4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Monad: Monad4<URI>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainRec: <A, S, R, E, B>(f: (a: A) => StateEnvEither<S, R, E, E.Either<A, B>>) => (value: A) => (s: S) => (r: R) => R.Resume<E.Either<E, readonly [B, S]>>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const ChainRec: ChainRec4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const MonadRec: MonadRec4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromEither: <E, A, S = unknown, R = unknown>(either: E.Either<E, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromEither: FromEither4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromIO: <A, S = unknown, R = unknown, E = never>(io: IO<A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromIO: FromIO4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromTask: <A, S = unknown, R = unknown, E = never>(io: Task<A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromTask: FromTask4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromResume: <A, S = unknown, R = unknown, E = never>(resume: R.Resume<A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromResume: FromResume4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromEnv: <R, A, S = unknown, E = never>(env: Env<R, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromEnv: FromEnv4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromState: FromState4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromReader: <R, A, S = unknown, E = never>(reader: Reader<R, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const FromReader: FromReader4<URI>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const ask: <S, R, E>() => StateEnvEither<S, R, E, R>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const asks: <R, A, S, E>(f: (r: R) => A) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainReaderK: <A, R, B>(f: (a: A) => Reader<R, B>) => <S, E>(ma: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromReaderK: <A extends readonly unknown[], R, B>(f: (...a: A) => Reader<R, B>) => <S, E>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainFirstResumeK: <A, B>(f: (value: A) => R.Resume<B>) => <S, R, E>(hkt: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainResumeK: <A, B>(f: (value: A) => R.Resume<B>) => <S, R, E>(hkt: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromResumeK: <A extends readonly any[], B>(f: (...args: A) => R.Resume<B>) => <S, R, E>(...args: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainEnvK: <A, R1, B>(f: (value: A) => Env<R1, B>) => <S, R2, E>(hkt: StateEnvEither<S, R2, E, A>) => StateEnvEither<S, R1 & R2, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainFirstEnvK: <A, R1, B>(f: (value: A) => Env<R1, B>) => <S, R2, E>(hkt: StateEnvEither<S, R2, E, A>) => StateEnvEither<S, R1 & R2, E, A>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromEnvK: <A extends readonly any[], R, B>(f: (...args: A) => Env<R, B>) => <S, E>(...args: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainFirstTaskK: <A, B>(f: (a: A) => Task<B>) => <S, R, E>(first: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainTaskK: <A, B>(f: (a: A) => Task<B>) => <S, R, E>(first: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromTaskK: <A extends readonly unknown[], B>(f: (...a: A) => Task<B>) => <S, R, E>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainFirstIOK: <A, B>(f: (a: A) => IO<B>) => <S, R, E>(first: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainIOK: <A, B>(f: (a: A) => IO<B>) => <S, R, E>(first: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromIOK: <A extends readonly unknown[], B>(f: (...a: A) => IO<B>) => <S, R, E>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainEitherK: <A, E, B>(f: (a: A) => E.Either<E, B>) => <S, R>(ma: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainOptionK: <E>(onNone: import("fp-ts/function").Lazy<E>) => <A, B>(f: (a: A) => import("fp-ts/Option").Option<B>) => <S, R>(ma: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const filterOrElse: {
<A, B extends A, E>(refinement: import("fp-ts/Refinement").Refinement<A, B>, onFalse: (a: A) => E): <S, R>(ma: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
<A_1, E_1>(predicate: import("fp-ts/Predicate").Predicate<A_1>, onFalse: (a: A_1) => E_1): <S_1, R_1, B_1 extends A_1>(mb: StateEnvEither<S_1, R_1, E_1, B_1>) => StateEnvEither<S_1, R_1, E_1, B_1>;
};
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromEitherK: <A extends readonly unknown[], E, B>(f: (...a: A) => E.Either<E, B>) => <S, R>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromOption: <E>(onNone: import("fp-ts/function").Lazy<E>) => import("fp-ts/NaturalTransformation").NaturalTransformation14C<"Option", "@typed/fp/StateEnvEither", E>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromOptionK: <E>(onNone: import("fp-ts/function").Lazy<E>) => <A extends readonly unknown[], B>(f: (...a: A) => import("fp-ts/Option").Option<B>) => <S, R>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromPredicate: {
<A, B extends A>(refinement: import("fp-ts/Refinement").Refinement<A, B>): <S, R>(a: A) => StateEnvEither<S, R, A, B>;
<A_1>(predicate: import("fp-ts/Predicate").Predicate<A_1>): <S_1, R_1, B_1 extends A_1>(b: B_1) => StateEnvEither<S_1, R_1, B_1, B_1>;
};
/**
* @since 0.9.2
* @category Combinator
*/
export declare const chainStateK: <A, S, B>(f: (a: A) => import("fp-ts/State").State<S, B>) => <R, E>(ma: StateEnvEither<S, R, E, A>) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const fromStateK: <A extends readonly unknown[], S, B>(f: (...a: A) => import("fp-ts/State").State<S, B>) => <R, E>(...a: A) => StateEnvEither<S, R, E, B>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const get: <S, R, E>() => StateEnvEither<S, R, E, S>;
/**
* @since 0.9.2
* @category Constructor
*/
export declare const gets: <S, R, E, A>(f: (s: S) => A) => StateEnvEither<S, R, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const modify: <S, R, E>(f: import("fp-ts/Endomorphism").Endomorphism<S>) => StateEnvEither<S, R, E, void>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const put: <S, R, E>(s: S) => StateEnvEither<S, R, E, void>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const useSome: <R1>(provided: R1) => <S, R2, E, A>(srte: StateEnvEither<S, R1 & R2, E, A>) => StateEnvEither<S, R2, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const provideSome: <R1>(provided: R1) => <S, R2, E, A>(srte: StateEnvEither<S, R1 & R2, E, A>) => StateEnvEither<S, R2, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const useAll: <R>(provided: R) => <S, E, A>(srte: StateEnvEither<S, R, E, A>) => StateEnvEither<S, unknown, E, A>;
/**
* @since 0.9.2
* @category Combinator
*/
export declare const provideAll: <R>(provided: R) => <S, E, A>(srte: StateEnvEither<S, R, E, A>) => StateEnvEither<S, unknown, E, A>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const UseSome: UseSome4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const UseAll: UseAll4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const ProvideSome: ProvideSome4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const ProvideAll: ProvideAll4<URI>;
/**
* @since 0.9.2
* @category Instance
*/
export declare const Provide: Provide4<URI>;
//# sourceMappingURL=StateEnvEither.d.ts.map