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

Data Structures and Resources for fp-ts

/**
 * ReaderOption is an OptionT of fp-ts/Reader
 * @since 0.9.2
 */
import * as Alt_ from 'fp-ts/Alt';
import { Alternative2 } from 'fp-ts/Alternative';
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 * as Ei from 'fp-ts/Either';
import { FromIO2 } from 'fp-ts/FromIO';
import { FromReader2 } from 'fp-ts/FromReader';
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 { MonadRec2 } from './MonadRec';
import { Provide2, ProvideAll2, ProvideSome2, UseAll2, UseSome2 } from './Provide';
import * as R from './Reader';
/**
 * @since 0.9.2
 * @category Model
 */
export interface ReaderOption<E, A> extends R.Reader<E, O.Option<A>> {
}
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const alt: <E, A>(second: Lazy<R.Reader<E, O.Option<A>>>) => (first: R.Reader<E, O.Option<A>>) => R.Reader<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const altW: <E1, A>(second: Lazy<ReaderOption<E1, A>>) => <E2, B>(first: ReaderOption<E2, B>) => ReaderOption<E1 & E2, A | B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const ap: <E, A>(fa: R.Reader<E, O.Option<A>>) => <B>(fab: R.Reader<E, O.Option<(a: A) => B>>) => R.Reader<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chain: <A, E, B>(f: (a: A) => R.Reader<E, O.Option<B>>) => (ma: R.Reader<E, O.Option<A>>) => R.Reader<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainNullableK: <A, B>(f: (a: A) => B | null | undefined) => <E>(ma: R.Reader<E, O.Option<A>>) => R.Reader<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: R.Reader<E, O.Option<A>>) => R.Reader<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromEither: <A, E>(e: Ei.Either<unknown, A>) => R.Reader<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromReader: <E, A>(ma: R.Reader<E, A>) => R.Reader<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromNullable: <A, E>(a: A) => R.Reader<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) => R.Reader<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) => R.Reader<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) => R.Reader<E, O.Option<B>>;
    <A_1>(predicate: import("fp-ts/Predicate").Predicate<A_1>): <E_1, B_1 extends A_1>(b: B_1) => R.Reader<E_1, O.Option<B_1>>;
};
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElse: <A>(onNone: Lazy<A>) => <E>(fa: R.Reader<E, O.Option<A>>) => R.Reader<E, A>;
/**
 * @since 0.13.0
 * @category Deconstructor
 */
export declare const getOrElseW: <A>(onNone: Lazy<A>) => <E, B>(fa: R.Reader<E, O.Option<B>>) => R.Reader<E, A | B>;
/**
 * @since 0.9.2
 * @category Deconsructor
 */
export declare const getOrElseE: <E, A>(onNone: Lazy<R.Reader<E, A>>) => (fa: R.Reader<E, O.Option<A>>) => R.Reader<E, A>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const getOrElseEW: <E1, A>(onNone: Lazy<R.Reader<E1, A>>) => <E2, B>(fa: ReaderOption<E2, B>) => R.Reader<E1 & E2, A | B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const map: <A, B>(f: (a: A) => B) => <E>(fa: R.Reader<E, O.Option<A>>) => R.Reader<E, O.Option<B>>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const match: <B, A>(onNone: () => B, onSome: (a: A) => B) => <E>(ma: R.Reader<E, O.Option<A>>) => R.Reader<E, B>;
/**
 * @since 0.9.2
 * @category Deconstructor
 */
export declare const matchE: <E, B, A>(onNone: () => R.Reader<E, B>, onSome: (a: A) => R.Reader<E, B>) => (ma: R.Reader<E, O.Option<A>>) => R.Reader<E, B>;
/**
 * @since 0.13.0
 * @category Deconstructor
 */
export declare const matchEW: <E1, B, A, E2, C>(onNone: () => R.Reader<E1, B>, onSome: (a: A) => R.Reader<E2, C>) => <E3>(ma: R.Reader<E3, O.Option<A>>) => R.Reader<E1 & E2 & E3, B | C>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const some: <A, E>(a: A) => R.Reader<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const zero: <E, A>() => R.Reader<E, O.Option<A>>;
/**
 * @since 0.9.2
 * @category URI
 */
export declare const URI = "@typed/fp/ReaderOption";
/**
 * @since 0.9.2
 * @category URI
 */
export declare type URI = typeof URI;
declare module 'fp-ts/HKT' {
    interface URItoKind2<E, A> {
        [URI]: ReaderOption<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.12.2
 * @category Constructor
 */
export declare const apFirst: <E, B>(second: ReaderOption<E, B>) => <A>(first: ReaderOption<E, A>) => ReaderOption<E, A>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apFirstW: <E1, B>(second: ReaderOption<E1, B>) => <E2, A>(first: ReaderOption<E2, A>) => ReaderOption<E1 & E2, A>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apS: <N extends string, A, E, B>(name: Exclude<N, keyof A>, fb: ReaderOption<E, B>) => (fa: ReaderOption<E, A>) => ReaderOption<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apSW: <N extends string, A, E1, B>(name: Exclude<N, keyof A>, fb: ReaderOption<E1, B>) => <E2>(fa: ReaderOption<E2, A>) => ReaderOption<E1 & E2, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apSecond: <E, B>(second: ReaderOption<E, B>) => <A>(first: ReaderOption<E, A>) => ReaderOption<E, B>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apSecondW: <E1, B>(second: ReaderOption<E1, B>) => <E2, A>(first: ReaderOption<E2, A>) => ReaderOption<E1 & E2, B>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apT: <E, B>(fb: ReaderOption<E, B>) => <A extends readonly unknown[]>(fas: ReaderOption<E, A>) => ReaderOption<E, readonly [...A, B]>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const apTW: <E1, B>(fb: ReaderOption<E1, B>) => <E2, A extends readonly unknown[]>(fas: ReaderOption<E2, A>) => ReaderOption<E1 & E2, readonly [...A, B]>;
/**
 * @since 0.12.2
 * @category Typeclass Instance
 */
export declare const getApplySemigroup: <A, E>(S: import("fp-ts/Semigroup").Semigroup<A>) => import("fp-ts/Semigroup").Semigroup<ReaderOption<E, A>>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Applicative: Applicative2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Chain: CH.Chain2<URI>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const bind: <N extends string, A, E, B>(name: Exclude<N, keyof A>, f: (a: A) => ReaderOption<E, B>) => (ma: ReaderOption<E, A>) => ReaderOption<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B; }>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const chainFirst: <A, E, B>(f: (a: A) => ReaderOption<E, B>) => (first: ReaderOption<E, A>) => ReaderOption<E, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainRec: <A, E, B>(f: (value: A) => ReaderOption<E, Ei.Either<A, B>>) => (value: A) => ReaderOption<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: Alt_.Alt2<URI>;
/**
 * @since 0.12.2
 * @category Constructor
 */
export declare const altAll: <E, A>(startWith: ReaderOption<E, A>) => (as: readonly ReaderOption<E, A>[]) => ReaderOption<E, A>;
/**
 * @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/ReaderOption">;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const FromReader: FromReader2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const UseSome: UseSome2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const UseAll: UseAll2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ProvideSome: ProvideSome2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ProvideAll: ProvideAll2<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Provide: Provide2<URI>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const ask: <R>() => ReaderOption<R, R>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const asks: <R, A>(f: (r: R) => A) => ReaderOption<R, A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderOption<R, A>) => ReaderOption<R, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainFirstReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderOption<R, A>) => ReaderOption<R, A>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromReaderK: <A extends readonly unknown[], R, B>(f: (...a: A) => R.Reader<R, B>) => (...a: A) => ReaderOption<R, B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const local: <A, B>(f: (a: A) => B) => <C>(ro: ReaderOption<B, C>) => ReaderOption<A, C>;
//# sourceMappingURL=ReaderOption.d.ts.map