ObservableEither overview
Added in v0.6.8
Table of contents
- Alt
- Apply
- Bifunctor
- Functor
- Monad
- MonadThrow
- combinators
- constructors
- destructors
- instances
- model
- utils
Alt
alt
Identifies an associative operation on a type constructor. It is similar to Semigroup
, except that it applies to types of kind * -> *
.
Signature
export declare const alt: <E, A>(
that: () => ObservableEither<E, A>
) => (fa: ObservableEither<E, A>) => ObservableEither<E, A>
Added in v0.6.8
Apply
ap
Apply a function to an argument under a type constructor.
Signature
export declare const ap: <E, A>(
fa: ObservableEither<E, A>
) => <B>(fab: ObservableEither<E, (a: A) => B>) => ObservableEither<E, B>
Added in v0.6.0
Bifunctor
bimap
Signature
export declare const bimap: <E, G, A, B>(
f: (e: E) => G,
g: (a: A) => B
) => (fa: ObservableEither<E, A>) => ObservableEither<G, B>
Added in v0.6.8
mapLeft
Signature
export declare const mapLeft: <E, G>(f: (e: E) => G) => <A>(fa: ObservableEither<E, A>) => ObservableEither<G, A>
Added in v0.6.8
Functor
map
map
can be used to turn functions (a: A) => B
into functions (fa: F<A>) => F<B>
whose argument and return types use the type constructor F
to represent some computational context.
Signature
export declare const map: <A, B>(f: (a: A) => B) => <E>(fa: ObservableEither<E, A>) => ObservableEither<E, B>
Added in v0.6.8
Monad
chain
Signature
export declare const chain: <A, E, B>(
f: (a: A) => ObservableEither<E, B>
) => (ma: ObservableEither<E, A>) => ObservableEither<E, B>
Added in v0.6.8
chainW
Less strict version of chain
.
Signature
export declare const chainW: <A, E2, B>(
f: (a: A) => ObservableEither<E2, B>
) => <E1>(ma: ObservableEither<E1, A>) => ObservableEither<E2 | E1, B>
Added in v0.6.12
MonadThrow
throwError
Signature
export declare const throwError: <E, A>(e: E) => ObservableEither<E, A>
Added in v0.6.12
combinators
apFirst
Combine two effectful actions, keeping only the result of the first.
Derivable from Apply
.
Signature
export declare const apFirst: <E, B>(
fb: ObservableEither<E, B>
) => <A>(fa: ObservableEither<E, A>) => ObservableEither<E, A>
Added in v0.6.8
apSecond
Combine two effectful actions, keeping only the result of the second.
Derivable from Apply
.
Signature
export declare const apSecond: <E, B>(
fb: ObservableEither<E, B>
) => <A>(fa: ObservableEither<E, A>) => ObservableEither<E, B>
Added in v0.6.8
chainFirst
Composes computations in sequence, using the return value of one computation to determine the next computation and keeping only the result of the first.
Derivable from Monad
.
Signature
export declare const chainFirst: <E, A, B>(
f: (a: A) => ObservableEither<E, B>
) => (ma: ObservableEither<E, A>) => ObservableEither<E, A>
Added in v0.6.8
flatten
Derivable from Monad
.
Signature
export declare const flatten: <E, A>(mma: ObservableEither<E, ObservableEither<E, A>>) => ObservableEither<E, A>
Added in v0.6.0
orElse
Signature
export declare const orElse: <E, A, M>(
onLeft: (e: E) => ObservableEither<M, A>
) => (ma: ObservableEither<E, A>) => ObservableEither<M, A>
Added in v0.6.8
swap
Signature
export declare const swap: <E, A>(ma: ObservableEither<E, A>) => ObservableEither<A, E>
Added in v0.6.8
constructors
fromIO
Signature
export declare const fromIO: <E, A>(fa: IO<A>) => ObservableEither<E, A>
Added in v0.6.12
fromIOEither
Signature
export declare const fromIOEither: <E, A>(fa: IOEither<E, A>) => ObservableEither<E, A>
Added in v0.6.8
fromObservable
Signature
export declare const fromObservable: <E, A>(fa: Observable<A>) => ObservableEither<E, A>
Added in v0.6.12
fromTask
Signature
export declare const fromTask: <E, A>(fa: Task<A>) => ObservableEither<E, A>
Added in v0.6.8
fromTaskEither
Signature
export declare const fromTaskEither: <E, A>(t: TE.TaskEither<E, A>) => ObservableEither<E, A>
Added in v0.6.8
left
Signature
export declare const left: <E = never, A = never>(e: E) => ObservableEither<E, A>
Added in v0.6.8
leftIO
Signature
export declare const leftIO: <E = never, A = never>(me: IO<E>) => ObservableEither<E, A>
Added in v0.6.8
leftObservable
Signature
export declare const leftObservable: <E = never, A = never>(ma: Observable<E>) => ObservableEither<E, A>
Added in v0.6.8
right
Signature
export declare const right: <E = never, A = never>(a: A) => ObservableEither<E, A>
Added in v0.6.8
rightIO
Signature
export declare const rightIO: <E = never, A = never>(ma: IO<A>) => ObservableEither<E, A>
Added in v0.6.8
rightObservable
Signature
export declare const rightObservable: <E = never, A = never>(ma: Observable<A>) => ObservableEither<E, A>
Added in v0.6.8
tryCatch
Signature
export declare const tryCatch: <A>(a: Observable<A>) => ObservableEither<unknown, A>
Added in v0.6.12
destructors
fold
Signature
export declare const fold: <E, A, B>(
onLeft: (e: E) => Observable<B>,
onRight: (a: A) => Observable<B>
) => (ma: ObservableEither<E, A>) => Observable<B>
Added in v0.6.8
getOrElse
Signature
export declare const getOrElse: <E, A>(onLeft: (e: E) => Observable<A>) => (ma: ObservableEither<E, A>) => Observable<A>
Added in v0.6.8
instances
Alt
Signature
export declare const Alt: Alt2<'ObservableEither'>
Added in v0.6.12
Applicative
Signature
export declare const Applicative: Applicative2<'ObservableEither'>
Added in v0.6.12
Apply
Signature
export declare const Apply: Apply2<'ObservableEither'>
Added in v0.6.12
Bifunctor
Signature
export declare const Bifunctor: Bifunctor2<'ObservableEither'>
Added in v0.6.12
Functor
Signature
export declare const Functor: Functor2<'ObservableEither'>
Added in v0.6.12
Monad
Signature
export declare const Monad: Monad2<'ObservableEither'>
Added in v0.6.12
MonadIO
Signature
export declare const MonadIO: MonadIO2<'ObservableEither'>
Added in v0.6.12
MonadObservable
Signature
export declare const MonadObservable: MonadObservable2<'ObservableEither'>
Added in v0.6.12
MonadTask
Signature
export declare const MonadTask: MonadTask2<'ObservableEither'>
Added in v0.6.12
MonadThrow
Signature
export declare const MonadThrow: MonadThrow2<'ObservableEither'>
Added in v0.6.12
URI
Signature
export declare const URI: 'ObservableEither'
Added in v0.6.8
URI (type alias)
Signature
export type URI = typeof URI
Added in v0.6.8
observableEither
Signature
export declare const observableEither: Monad2<'ObservableEither'> &
Bifunctor2<'ObservableEither'> &
Alt2<'ObservableEither'> &
MonadObservable2<'ObservableEither'> &
MonadThrow2<'ObservableEither'>
Added in v0.6.8
model
ObservableEither (interface)
Signature
export interface ObservableEither<E, A> extends Observable<E.Either<E, A>> {}
Added in v0.6.8
utils
Do
Signature
export declare const Do: ObservableEither<never, {}>
Added in v0.6.12
bind
Signature
export declare const bind: <K extends string, E, A, B>(
name: Exclude<K, keyof A>,
f: (a: A) => ObservableEither<E, B>
) => (fa: ObservableEither<E, A>) => ObservableEither<E, { [P in K | keyof A]: P extends keyof A ? A[P] : B }>
Added in v0.6.11
bindTo
Signature
export declare const bindTo: <K extends string, E, A>(
name: K
) => (fa: ObservableEither<E, A>) => ObservableEither<E, { [P in K]: A }>
Added in v0.6.11
bindW
Signature
export declare const bindW: <K extends string, E2, A, B>(
name: Exclude<K, keyof A>,
f: (a: A) => ObservableEither<E2, B>
) => <E1>(
fa: ObservableEither<E1, A>
) => ObservableEither<E2 | E1, { [P in K | keyof A]: P extends keyof A ? A[P] : B }>
Added in v0.6.12
filterOrElse
Derivable from MonadThrow
.
Signature
export declare const filterOrElse: {
<E, A, B extends A>(refinement: Refinement<A, B>, onFalse: (a: A) => E): (
ma: ObservableEither<E, A>
) => ObservableEither<E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): (ma: ObservableEither<E, A>) => ObservableEither<E, A>
}
Added in v0.6.10
fromEither
Derivable from MonadThrow
.
Signature
export declare const fromEither: <E, A>(ma: E.Either<E, A>) => ObservableEither<E, A>
Added in v0.6.10
fromOption
Derivable from MonadThrow
.
Signature
export declare const fromOption: <E>(onNone: () => E) => <A>(ma: Option<A>) => ObservableEither<E, A>
Added in v0.6.10
fromPredicate
Derivable from MonadThrow
.
Signature
export declare const fromPredicate: {
<E, A, B extends A>(refinement: Refinement<A, B>, onFalse: (a: A) => E): (a: A) => ObservableEither<E, B>
<E, A>(predicate: Predicate<A>, onFalse: (a: A) => E): (a: A) => ObservableEither<E, A>
}
Added in v0.6.10
of
Signature
export declare const of: <E, A>(a: A) => ObservableEither<E, A>
Added in v0.6.12
toTaskEither
Signature
export declare const toTaskEither: <E, A>(o: ObservableEither<E, A>) => TE.TaskEither<E, A>
Added in v0.6.8