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

Data Structures and Resources for fp-ts

/**
 * StreamOption is a OptionT of Stream
 * @since 0.9.2
 */
import { Applicative1 } from 'fp-ts/Applicative';
import { Apply1 } from 'fp-ts/Apply';
import { Chain1 } from 'fp-ts/Chain';
import { ChainRec1 } from 'fp-ts/ChainRec';
import * as Ei from 'fp-ts/Either';
import { Functor1 } from 'fp-ts/Functor';
import { Monad1 } from 'fp-ts/Monad';
import * as O from 'fp-ts/Option';
import { Pointed1 } from 'fp-ts/Pointed';
import { MonadRec1 } from './MonadRec';
import * as S from './Stream';
/**
 * @since 0.9.2
 * @category Model
 */
export interface StreamOption<A> extends S.Stream<O.Option<A>> {
}
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const alt: <A>(second: import("fp-ts/function").Lazy<import("@most/types").Stream<O.Option<A>>>) => (first: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<O.Option<A>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const ap: <A>(fa: import("@most/types").Stream<O.Option<A>>) => <B>(fab: import("@most/types").Stream<O.Option<(a: A) => B>>) => import("@most/types").Stream<O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chain: <A, B>(f: (a: A) => import("@most/types").Stream<O.Option<B>>) => (ma: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainNullableK: <A, B>(f: (a: A) => B | null | undefined) => (ma: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<O.Option<NonNullable<B>>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainOptionK: <A, B>(f: (a: A) => O.Option<B>) => (ma: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<O.Option<B>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromEither: <A>(e: Ei.Either<unknown, A>) => import("@most/types").Stream<O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromStream: <A>(ma: import("@most/types").Stream<A>) => import("@most/types").Stream<O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const fromNullable: <A>(a: A) => import("@most/types").Stream<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) => (...a: A) => import("@most/types").Stream<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>) => (...a: A) => import("@most/types").Stream<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>): (a: A) => import("@most/types").Stream<O.Option<B>>;
    <A_1>(predicate: import("fp-ts/Predicate").Predicate<A_1>): <B_1 extends A_1>(b: B_1) => import("@most/types").Stream<O.Option<B_1>>;
};
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const getOrElse: <A>(onNone: import("fp-ts/function").Lazy<A>) => (fa: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const getOrElseE: <A>(onNone: import("fp-ts/function").Lazy<import("@most/types").Stream<A>>) => (fa: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<A>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const map: <A, B>(f: (a: A) => B) => (fa: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<O.Option<B>>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const match: <B, A>(onNone: () => B, onSome: (a: A) => B) => (ma: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<B>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const matchE: <B, A>(onNone: () => import("@most/types").Stream<B>, onSome: (a: A) => import("@most/types").Stream<B>) => (ma: import("@most/types").Stream<O.Option<A>>) => import("@most/types").Stream<B>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const some: <A>(a: A) => import("@most/types").Stream<O.Option<A>>;
/**
 * @since 0.9.2
 * @category Constructor
 */
export declare const zero: <A>() => import("@most/types").Stream<O.Option<A>>;
/**
 * @since 0.9.2
 * @category URI
 */
export declare const URI = "@typed/fp/StreamOption";
/**
 * @since 0.9.2
 * @category URI
 */
export declare type URI = typeof URI;
declare module 'fp-ts/HKT' {
    interface URItoKind<A> {
        [URI]: StreamOption<A>;
    }
}
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Pointed: Pointed1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Functor: Functor1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Apply: Apply1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Applicative: Applicative1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Chain: Chain1<URI>;
/**
 * @since 0.9.2
 * @category Combinator
 */
export declare const chainRec: <A, B>(f: (value: A) => StreamOption<Ei.Either<A, B>>) => (value: A) => StreamOption<B>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const ChainRec: ChainRec1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const Monad: Monad1<URI>;
/**
 * @since 0.9.2
 * @category Instance
 */
export declare const MonadRec: MonadRec1<URI>;
//# sourceMappingURL=StreamOption.d.ts.map