@typed/fp/cjs/FxEnv.d.ts

Data Structures and Resources for fp-ts

/**
 * @typed/fp/FxEnv is a generator-based do-notation for Env.
 *
 * @since 0.13.0
 */
import { Applicative2 } from 'fp-ts/Applicative';
import * as Ap from 'fp-ts/Apply';
import * as Ch from 'fp-ts/Chain';
import { ChainRec2 } from 'fp-ts/ChainRec';
import { FromReader2 } from 'fp-ts/FromReader';
import * as F from 'fp-ts/Functor';
import * as IO from 'fp-ts/IO';
import { Monad2 } from 'fp-ts/Monad';
import { Pointed2 } from 'fp-ts/Pointed';
import * as R from 'fp-ts/Reader';
import * as T from 'fp-ts/Task';
import * as E from './Env';
import { Fx } from './Fx';
import * as FxT from './FxT';
import * as P from './Provide';
import * as Re from './Resume';
/**
 * @category Constructor
 * @since 0.13.0
 */
export declare const of: <A, E = unknown>(value: A) => Fx<E.Env<E, A>, A, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const ap: <E1, A>(fa: Fx<E.Env<E1, unknown>, A, unknown>) => <E2, B>(fab: Fx<E.Env<E2, unknown>, import("./function").Arity1<A, B>, unknown>) => Fx<E.Env<E1 & E2, unknown>, B, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const chain: <A, E1, B>(f: (value: A) => Fx<E.Env<E1, unknown>, B, unknown>) => <E2>(fx: Fx<E.Env<E2, unknown>, A, unknown>) => Fx<E.Env<E1 & E2, unknown>, B, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const chainRec: <A, E, B>(f: import("./function").Arity1<A, Fx<E.Env<E, unknown>, import("fp-ts/Either").Either<A, B>, unknown>>) => (a: A) => Fx<E.Env<E, unknown>, B, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const doEnv: <Y extends E.Env<any, any>, R, N = unknown>(f: (lift: FxT.LiftFx2<"@typed/fp/Env">) => Generator<Y, R, N>) => Fx<Y, R, N>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const liftEnv: FxT.LiftFx2<"@typed/fp/Env">;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const map: <A, B>(f: (value: A) => B) => <E>(fx: Fx<E.Env<E, unknown>, A, unknown>) => Fx<E.Env<E, unknown>, B, unknown>;
/**
 * @category Interpreter
 * @since 0.13.0
 */
export declare const toEnv: <Y extends E.Env<any, any>, R>(fx: Fx<Y, R, unknown>) => [Y] extends [E.Env<infer E, any>] ? E.Env<E, R> : never;
/**
 * @category Interpreter
 * @since 0.13.0
 */
export declare const Do: <Y extends E.Env<any, any>, R, N = unknown>(f: (lift: FxT.LiftFx2<"@typed/fp/Env">) => Generator<Y, R, N>) => [Y] extends [E.Env<infer E, any>] ? E.Env<E, R> : never;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const useSome: <A>(provided: A) => <B, T>(fx: Fx<E.Env<A & B, unknown>, T, unknown>) => Fx<E.Env<B, unknown>, T, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const useAll: <A>(provided: A) => <T>(fx: Fx<E.Env<A, unknown>, T, unknown>) => Fx<E.Env<unknown, unknown>, T, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const provideSome: <A>(provided: A) => <B, T>(fx: Fx<E.Env<A & B, unknown>, T, unknown>) => Fx<E.Env<B, unknown>, T, unknown>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const provideAll: <A>(provided: A) => <T>(fx: Fx<E.Env<A, unknown>, T, unknown>) => Fx<E.Env<unknown, unknown>, T, unknown>;
/**
 * @category Constructor
 * @since 0.13.0
 */
export declare const fromIO: <A, E = unknown>(fa: IO.IO<A>) => Fx<E.Env<E, A>, A, unknown>;
/**
 * @category Constructor
 * @since 0.13.0
 */
export declare const fromResume: <A, E = unknown>(fa: Re.Resume<A>) => Fx<E.Env<E, A>, A, unknown>;
/**
 * @category Constructor
 * @since 0.13.0
 */
export declare const fromTask: <A, E = unknown>(fa: T.Task<A>) => Fx<E.Env<E, A>, A, unknown>;
/**
 * @category ConstructorfromReader
 * @since 0.13.0
 */
export declare const asks: <E, A>(fa: R.Reader<E, A>) => Fx<E.Env<E, A>, A, unknown>;
/**
 * @category Constructor
 * @since 0.13.0
 */
export declare const ask: <A>() => Fx<E.Env<A, A>, A, unknown>;
/**
 * @category URI
 * @since 0.13.0
 */
export declare const URI = "@typed/fp/Fx/Env";
/**
 * @category URI
 * @since 0.13.0
 */
export declare type URI = typeof URI;
/**
 * @category Model
 * @since 0.13.0
 */
export interface FxEnv<E, A> extends Fx<E.Env<E, unknown>, A> {
}
/**
 * @category Type-level
 * @since 0.13.0
 */
export declare type GetRequirements<A> = A extends FxEnv<infer E, any> ? E : never;
/**
 * @category Type-level
 * @since 0.13.0
 */
export declare type GetValue<A> = A extends FxEnv<any, infer R> ? R : never;
declare module 'fp-ts/HKT' {
    interface URItoKind2<E, A> {
        [URI]: FxEnv<E, A>;
    }
}
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Pointed: Pointed2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Functor: F.Functor2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Apply: Ap.Apply2<URI>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apFirst: <E, B>(second: FxEnv<E, B>) => <A>(first: FxEnv<E, A>) => FxEnv<E, A>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apFirstW: <E1, B>(second: FxEnv<E1, B>) => <E2, A>(first: FxEnv<E2, A>) => FxEnv<E1 & E2, A>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apS: <N extends string, A, E, B>(name: Exclude<N, keyof A>, fb: FxEnv<E, B>) => (fa: FxEnv<E, A>) => FxEnv<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apSW: <N extends string, A, E1, B>(name: Exclude<N, keyof A>, fb: FxEnv<E1, B>) => <E2>(fa: FxEnv<E2, A>) => FxEnv<E1 & E2, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apSecond: <E, B>(second: FxEnv<E, B>) => <A>(first: FxEnv<E, A>) => FxEnv<E, B>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apSecondW: <E1, B>(second: FxEnv<E1, B>) => <E2, A>(first: FxEnv<E2, A>) => FxEnv<E1 & E2, A>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apT: <E, B>(fb: FxEnv<E, B>) => <A extends readonly unknown[]>(fas: FxEnv<E, A>) => FxEnv<E, readonly [...A, B]>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const apTW: <E1, B>(fb: FxEnv<E1, B>) => <E2, A extends readonly unknown[]>(fas: FxEnv<E2, A>) => FxEnv<E1 & E2, readonly [...A, B]>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const getApplySemigroup: <A, E>(S: import("fp-ts/Semigroup").Semigroup<A>) => import("fp-ts/Semigroup").Semigroup<FxEnv<E, A>>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Applicative: Applicative2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Chain: Ch.Chain2<URI>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const bind: <N extends string, A, E, B>(name: Exclude<N, keyof A>, f: (a: A) => FxEnv<E, B>) => (ma: FxEnv<E, A>) => FxEnv<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @category Combinator
 * @since 0.13.0
 */
export declare const chainFirst: <A, E, B>(f: (a: A) => FxEnv<E, B>) => (first: FxEnv<E, A>) => FxEnv<E, A>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Monad: Monad2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const ChainRec: ChainRec2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const UseSome: P.UseSome2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const UseAll: P.UseAll2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const ProvideSome: P.ProvideSome2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const ProvideAll: P.ProvideAll2<URI>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const Provide: P.Provide2<URI>;
/**
 * @since 0.13.0
 * @category Constructor
 */
export declare const fromReader: <R, A>(ma: R.Reader<R, A>) => Fx<E.Env<R, A>, A, unknown>;
/**
 * @category Instance
 * @since 0.13.0
 */
export declare const FromReader: FromReader2<URI>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const provideAllWith: <R, A>(provider: FxEnv<R, A>) => <B>(hkt: FxEnv<A, B>) => FxEnv<R, B>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const useAllWith: <R, A>(provider: FxEnv<R, A>) => <B>(hkt: FxEnv<A, B>) => FxEnv<R, B>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const provideSomeWith: <E1, A>(provider: FxEnv<E1, A>) => P.Provider2<"@typed/fp/Fx/Env", A, E1>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const useSomeWith: <E1, A>(provider: FxEnv<E1, A>) => P.Provider2<"@typed/fp/Fx/Env", A, E1>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const askAndUse: <E, B>(hkt: FxEnv<E, B>) => FxEnv<E, FxEnv<unknown, B>>;
/**
 * @since 0.13.0
 * @category Combinator
 */
export declare const askAndProvide: <E, B>(hkt: FxEnv<E, B>) => FxEnv<E, FxEnv<unknown, B>>;
//# sourceMappingURL=FxEnv.d.ts.map