@typed/fp/esm/ReaderStreamOption.d.ts

Data Structures and Resources for fp-ts

/**
 * ReaderStreamEither is an Option of ReaderStream, allowing for you to
 * represent your application over time with Stream, with support for Optionality
 * through Option, and dependency injection from Reader.
 *
 * @since 0.9.2
 */
import { Alt2 } from 'fp-ts/Alt';
import { Alternative2 } from 'fp-ts/Alternative';
import { Applicative2 } from 'fp-ts/Applicative';
import * as Ap from 'fp-ts/Apply';
import { Chain2 } from 'fp-ts/Chain';
import { ChainRec2 } from 'fp-ts/ChainRec';
import * as Ei from 'fp-ts/Either';
import { FromIO2 } from 'fp-ts/FromIO';
import { FromReader2 } from 'fp-ts/FromReader';
import { FromTask2 } from 'fp-ts/FromTask';
import { Lazy } from 'fp-ts/function';
import { Functor2 } from 'fp-ts/Functor';
import { Monad2 } from 'fp-ts/Monad';
import * as O from 'fp-ts/Option';
import { Pointed2 } from 'fp-ts/Pointed';
import { FromEnv2 } from './FromEnv';
import * as FRS from './FromReaderStream';
import { FromResume2 } from './FromResume';
import * as FS from './FromStream';
import { MonadRec2 } from './MonadRec';
import * as P from './Provide';
import * as RS from './ReaderStream';
import { Resume } from './Resume';
/**
 * @since 0.9.2
 * @category Model
 */
export interface ReaderStreamOption<E, A> extends RS.ReaderStream<E, O.Option<A>> {
}
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const alt: <E, A>(second: Lazy<RS.ReaderStream<E, O.Option<A>>>) => (first: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const ap: <E, A>(fa: RS.ReaderStream<E, O.Option<A>>) => <B>(fab: RS.ReaderStream<E, O.Option<(a: A) => B>>) => RS.ReaderStream<E, O.Option<B>>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apW: <E1, A>(fa: RS.ReaderStream<E1, O.Option<A>>) => <E2, B>(fab: RS.ReaderStream<E2, O.Option<(a: A) => B>>) => RS.ReaderStream<E1 & E2, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chain: <A, E, B>(f: (a: A) => RS.ReaderStream<E, O.Option<B>>) => (ma: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, O.Option<B>>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const chainW: <A, E1, B>(f: (a: A) => RS.ReaderStream<E1, O.Option<B>>) => <E2>(ma: RS.ReaderStream<E2, O.Option<A>>) => RS.ReaderStream<E1 & E2, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainNullableK: <A, B>(f: (a: A) => B | null | undefined) => <E>(ma: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, O.Option<NonNullable<B>>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainOptionK: <A, B>(f: (a: A) => O.Option<B>) => <E>(ma: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromEither: <A, E>(e: Ei.Either<unknown, A>) => RS.ReaderStream<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromReaderStream: <E, A>(ma: RS.ReaderStream<E, A>) => RS.ReaderStream<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromNullable: <A, E>(a: A) => RS.ReaderStream<E, O.Option<NonNullable<A>>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromNullableK: <A extends readonly unknown[], B>(f: (...a: A) => B | null | undefined) => <E>(...a: A) => RS.ReaderStream<E, O.Option<NonNullable<B>>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromOptionK: <A extends readonly unknown[], B>(f: (...a: A) => O.Option<B>) => <E>(...a: A) => RS.ReaderStream<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromPredicate: {
    <A, B extends A>(refinement: import("fp-ts/Refinement").Refinement<A, B>): <E>(a: A) => RS.ReaderStream<E, O.Option<B>>;
    <A_1>(predicate: import("fp-ts/Predicate").Predicate<A_1>): <E_1, B_1 extends A_1>(b: B_1) => RS.ReaderStream<E_1, O.Option<B_1>>;
};
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElse: <A>(onNone: Lazy<A>) => <E>(fa: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, A>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElseE: <E, A>(onNone: Lazy<RS.ReaderStream<E, A>>) => (fa: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const map: <A, B>(f: (a: A) => B) => <E>(fa: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const match: <B, A>(onNone: () => B, onSome: (a: A) => B) => <E>(ma: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, B>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const matchE: <E, B, A>(onNone: () => RS.ReaderStream<E, B>, onSome: (a: A) => RS.ReaderStream<E, B>) => (ma: RS.ReaderStream<E, O.Option<A>>) => RS.ReaderStream<E, B>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const some: <A, E>(a: A) => RS.ReaderStream<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const zero: <E, A>() => RS.ReaderStream<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElseW: <A>(onNone: Lazy<A>) => <E, B>(fa: RS.ReaderStream<E, O.Option<B>>) => RS.ReaderStream<E, A | B>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElseEW: <E1, A>(onNone: Lazy<RS.ReaderStream<E1, A>>) => <E2>(fa: RS.ReaderStream<E2, O.Option<A>>) => RS.ReaderStream<E1 & E2, A>;
/**
 * @since 0.9.2
 * @category URI
 */
export declare const URI = "@typed/fp/ReaderStreamOption";
/**
 * @since 0.9.2
 * @category URI
 */
export declare type URI = typeof URI;
declare module 'fp-ts/HKT' {
    interface URItoKind2<E, A> {
        [URI]: ReaderStreamOption<E, A>;
    }
}
declare module './HKT' {
    interface URItoVariance {
        [URI]: V<E, Contravariant>;
    }
}
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Pointed: Pointed2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Functor: Functor2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Apply: Ap.Apply2<URI>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apFirst: <E, B>(second: ReaderStreamOption<E, B>) => <A>(first: ReaderStreamOption<E, A>) => ReaderStreamOption<E, A>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apFirstW: <E1, B>(second: ReaderStreamOption<E1, B>) => <E2, A>(first: ReaderStreamOption<E2, A>) => ReaderStreamOption<E1 & E2, A>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apS: <N extends string, A, E, B>(name: Exclude<N, keyof A>, fb: ReaderStreamOption<E, B>) => (fa: ReaderStreamOption<E, A>) => ReaderStreamOption<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apSW: <N extends string, A, E1, B>(name: Exclude<N, keyof A>, fb: ReaderStreamOption<E1, B>) => <E2>(fa: ReaderStreamOption<E2, A>) => ReaderStreamOption<E1 & E2, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apSecond: <E, B>(second: ReaderStreamOption<E, B>) => <A>(first: ReaderStreamOption<E, A>) => ReaderStreamOption<E, B>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apSecondW: <E1, B>(second: ReaderStreamOption<E1, B>) => <E2, A>(first: ReaderStreamOption<E2, A>) => ReaderStreamOption<E1 & E2, B>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apT: <E, B>(fb: ReaderStreamOption<E, B>) => <A extends readonly unknown[]>(fas: ReaderStreamOption<E, A>) => ReaderStreamOption<E, readonly [...A, B]>;
/**
 * @since 0.11.0
 * @category Combinator
 */
export declare const apTW: <E1, B>(fb: ReaderStreamOption<E1, B>) => <E2, A extends readonly unknown[]>(fas: ReaderStreamOption<E2, A>) => ReaderStreamOption<E1 & E2, readonly [...A, B]>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Applicative: Applicative2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Chain: Chain2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainRec: <A, E, B>(f: (value: A) => ReaderStreamOption<E, Ei.Either<A, B>>) => (value: A) => ReaderStreamOption<E, B>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ChainRec: ChainRec2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Monad: Monad2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const MonadRec: MonadRec2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Alt: Alt2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Alternative: Alternative2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromIO: FromIO2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromIO: import("fp-ts/NaturalTransformation").NaturalTransformation12<"IO", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromTask: FromTask2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromTask: import("fp-ts/NaturalTransformation").NaturalTransformation12<"Task", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromResume: FromResume2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromResume: import("fp-ts/NaturalTransformation").NaturalTransformation12<"@typed/fp/Resume", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromEnv: FromEnv2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromEnv: import("fp-ts/NaturalTransformation").NaturalTransformation22<"@typed/fp/Env", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromReader: FromReader2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromReader: import("fp-ts/NaturalTransformation").NaturalTransformation22<"Reader", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const UseSome: P.UseSome2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const useSome: <A>(provided: A) => <B, C>(hkt: ReaderStreamOption<A & B, C>) => ReaderStreamOption<B, C>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const UseAll: P.UseAll2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const useAll: <A>(provided: A) => <B>(hkt: ReaderStreamOption<Partial<A>, B>) => ReaderStreamOption<unknown, B>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ProvideSome: P.ProvideSome2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const provideSome: <A>(provided: A) => <B, C>(hkt: ReaderStreamOption<A & B, C>) => ReaderStreamOption<B, C>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ProvideAll: P.ProvideAll2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const provideAll: <A>(provided: A) => <B>(hkt: ReaderStreamOption<Partial<A>, B>) => ReaderStreamOption<unknown, B>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Provide: P.Provide2<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const askAndProvide: <E, B>(hkt: ReaderStreamOption<E, B>) => ReaderStreamOption<E, ReaderStreamOption<unknown, B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const askAndUse: <E, B>(hkt: ReaderStreamOption<E, B>) => ReaderStreamOption<E, ReaderStreamOption<unknown, B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const provideAllWith: <R, A>(provider: ReaderStreamOption<R, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<R, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const provideSomeWith: <E1, A>(provider: ReaderStreamOption<E1, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E1>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const useAllWith: <R, A>(provider: ReaderStreamOption<R, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<R, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const useSomeWith: <E1, A>(provider: ReaderStreamOption<E1, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E1>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const ask: <R>() => ReaderStreamOption<R, R>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const asks: <R, A>(f: (r: R) => A) => ReaderStreamOption<R, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainReaderK: <A, R, B>(f: (a: A) => import("fp-ts/Reader").Reader<R, B>) => (ma: ReaderStreamOption<R, A>) => ReaderStreamOption<R, B>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromReaderK: <A extends readonly unknown[], R, B>(f: (...a: A) => import("fp-ts/Reader").Reader<R, B>) => (...a: A) => ReaderStreamOption<R, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainFirstResumeK: <A, B>(f: (value: A) => Resume<B>) => <E>(hkt: ReaderStreamOption<E, A>) => ReaderStreamOption<E, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainResumeK: <A, B>(f: (value: A) => Resume<B>) => <E>(hkt: ReaderStreamOption<E, A>) => ReaderStreamOption<E, B>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromResumeK: <A extends readonly any[], B>(f: (...args: A) => Resume<B>) => <E>(...args: A) => ReaderStreamOption<E, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainEnvK: <A, R1, B>(f: (value: A) => import("./Env").Env<R1, B>) => <R2>(hkt: ReaderStreamOption<R2, A>) => ReaderStreamOption<R1 & R2, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainFirstEnvK: <A, R1, B>(f: (value: A) => import("./Env").Env<R1, B>) => <R2>(hkt: ReaderStreamOption<R2, A>) => ReaderStreamOption<R1 & R2, A>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromEnvK: <A extends readonly any[], R, B>(f: (...args: A) => import("./Env").Env<R, B>) => (...args: A) => ReaderStreamOption<R, B>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const provideAllWithEnv: <E, A>(env: import("./Env").Env<E, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<E, B>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const provideSomeWithEnv: <E, A>(env: import("./Env").Env<E, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const useSomeWithEnv: <E, A>(env: import("./Env").Env<E, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const useAllWithEnv: <E, A>(env: import("./Env").Env<E, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<E, B>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromStream: FS.FromStream2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromStream: import("fp-ts/NaturalTransformation").NaturalTransformation12<"@most/core/Stream", "@typed/fp/ReaderStreamOption">;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainFirstStreamK: <A, B>(f: (value: A) => import("./Stream").Stream<B>) => <E>(hkt: ReaderStreamOption<E, A>) => ReaderStreamOption<E, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainStreamK: <A, B>(f: (value: A) => import("./Stream").Stream<B>) => <E>(hkt: ReaderStreamOption<E, A>) => ReaderStreamOption<E, B>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromStreamK: <A extends readonly any[], B>(f: (...args: A) => import("./Stream").Stream<B>) => <E>(...args: A) => ReaderStreamOption<E, B>;
/**
 * @since 0.13.9
 * @category Instance
 */
export declare const FromReaderStream: FRS.FromReaderStream2<URI>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const chainFirstReaderStreamK: <A, R1, B>(f: (value: A) => RS.ReaderStream<R1, B>) => <R2>(hkt: ReaderStreamOption<R2, A>) => ReaderStreamOption<R1 & R2, A>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const chainReaderStreamK: <A, R1, B>(f: (value: A) => RS.ReaderStream<R1, B>) => <R2>(hkt: ReaderStreamOption<R2, A>) => ReaderStreamOption<R1 & R2, B>;
/**
 * @since 0.13.9
 * @category Constructor
 */
export declare const fromReaderStreamK: <A extends readonly any[], R, B>(f: (...args: A) => RS.ReaderStream<R, B>) => (...args: A) => ReaderStreamOption<R, B>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const provideAllWithReaderStream: <E, A>(stream: RS.ReaderStream<E, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<E, B>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const provideSomeWithReaderStream: <E, A>(stream: RS.ReaderStream<E, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const useSomeWithReaderStream: <E, A>(stream: RS.ReaderStream<E, A>) => P.Provider2<"@typed/fp/ReaderStreamOption", A, E>;
/**
 * @since 0.13.9
 * @category Combinator
 */
export declare const useAllWithReaderStream: <E, A>(stream: RS.ReaderStream<E, A>) => <B>(hkt: ReaderStreamOption<A, B>) => ReaderStreamOption<E, B>;
//# sourceMappingURL=ReaderStreamOption.d.ts.map