Link Search Menu Expand Document

TaskOption overview

Added in v2.10.0


Table of contents


Alt

alt

Signature

export declare const alt: <A>(second: Lazy<TaskOption<A>>) => (first: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

altW

Less strict version of alt.

Signature

export declare const altW: <B>(second: Lazy<TaskOption<B>>) => <A>(first: TaskOption<A>) => TaskOption<B | A>

Added in v2.10.0

Alternative

zero

Signature

export declare const zero: <A>() => TaskOption<A>

Added in v2.10.0

Apply

ap

Signature

export declare const ap: <A>(fa: TaskOption<A>) => <B>(fab: TaskOption<(a: A) => B>) => TaskOption<B>

Added in v2.10.0

Compactable

compact

Signature

export declare const compact: <A>(fa: TaskOption<O.Option<A>>) => TaskOption<A>

Added in v2.10.0

separate

Signature

export declare const separate: <A, B>(fa: TaskOption<Either<A, B>>) => Separated<TaskOption<A>, TaskOption<B>>

Added in v2.10.0

Filterable

filter

Signature

export declare const filter: <A>(predicate: Predicate<A>) => (fga: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

filterMap

Signature

export declare const filterMap: <A, B>(f: (a: A) => O.Option<B>) => (fga: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

partition

Signature

export declare const partition: <A>(
  predicate: Predicate<A>
) => (fga: TaskOption<A>) => Separated<TaskOption<A>, TaskOption<A>>

Added in v2.10.0

partitionMap

Signature

export declare const partitionMap: <A, B, C>(
  f: (a: A) => Either<B, C>
) => (fa: TaskOption<A>) => Separated<TaskOption<B>, TaskOption<C>>

Added in v2.10.0

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) => (fa: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

Monad

chain

Signature

export declare const chain: <A, B>(f: (a: A) => TaskOption<B>) => (ma: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

Pointed

of

Signature

export declare const of: <A>(a: A) => TaskOption<A>

Added in v2.10.0

combinators

apFirst

Combine two effectful actions, keeping only the result of the first.

Derivable from Apply.

Signature

export declare const apFirst: <B>(second: TaskOption<B>) => <A>(first: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

apSecond

Combine two effectful actions, keeping only the result of the second.

Derivable from Apply.

Signature

export declare const apSecond: <B>(second: TaskOption<B>) => <A>(first: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

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 Chain.

Signature

export declare const chainFirst: <A, B>(f: (a: A) => TaskOption<B>) => (first: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

chainFirstIOK

Signature

export declare const chainFirstIOK: <A, B>(f: (a: A) => IO<B>) => (first: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

chainFirstTaskK

Signature

export declare const chainFirstTaskK: <A, B>(f: (a: A) => T.Task<B>) => (first: TaskOption<A>) => TaskOption<A>

Added in v2.10.0

chainIOK

Signature

export declare const chainIOK: <A, B>(f: (a: A) => IO<B>) => (first: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

chainOptionK

Signature

export declare const chainOptionK: <A, B>(f: (a: A) => O.Option<B>) => (ma: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

chainTaskK

Signature

export declare const chainTaskK: <A, B>(f: (a: A) => T.Task<B>) => (first: TaskOption<A>) => TaskOption<B>

Added in v2.10.0

flap

Derivable from Functor.

Signature

export declare const flap: <A>(a: A) => <B>(fab: TaskOption<(a: A) => B>) => TaskOption<B>

Added in v2.10.0

flatten

Derivable from Chain.

Signature

export declare const flatten: <A>(mma: TaskOption<TaskOption<A>>) => TaskOption<A>

Added in v2.10.0

fromIOK

Signature

export declare const fromIOK: <A, B>(f: (...a: A) => IO<B>) => (...a: A) => TaskOption<B>

Added in v2.10.0

fromOptionK

Signature

export declare const fromOptionK: <A extends readonly unknown[], B>(
  f: (...a: A) => O.Option<B>
) => (...a: A) => TaskOption<B>

Added in v2.10.0

fromTaskK

Signature

export declare const fromTaskK: <A, B>(f: (...a: A) => T.Task<B>) => (...a: A) => TaskOption<B>

Added in v2.10.0

constructors

fromEither

Signature

export declare const fromEither: <A>(e: Either<unknown, A>) => TaskOption<A>

Added in v2.10.0

fromIO

Signature

export declare const fromIO: <A>(fa: IO<A>) => TaskOption<A>

Added in v2.10.0

fromOption

Signature

export declare const fromOption: <A>(ma: O.Option<A>) => TaskOption<A>

Added in v2.10.0

fromPredicate

Signature

export declare const fromPredicate: {
  <A, B extends A>(refinement: Refinement<A, B>): (a: A) => TaskOption<B>
  <A>(predicate: Predicate<A>): (a: A) => TaskOption<A>
}

Added in v2.10.0

fromTask

Signature

export declare const fromTask: <A>(fa: T.Task<A>) => TaskOption<A>

Added in v2.10.0

none

Signature

export declare const none: TaskOption<never>

Added in v2.10.0

some

Signature

export declare const some: <A>(a: A) => TaskOption<A>

Added in v2.10.0

destructors

fold

Alias of matchE.

Signature

export declare const fold: <B, A>(
  onNone: () => T.Task<B>,
  onSome: (a: A) => T.Task<B>
) => (ma: TaskOption<A>) => T.Task<B>

Added in v2.10.0

foldW

Alias of matchEW.

Signature

export declare const foldW: <B, C, A>(
  onNone: () => T.Task<B>,
  onSome: (a: A) => T.Task<C>
) => (ma: TaskOption<A>) => T.Task<B | C>

Added in v2.10.0

getOrElse

Signature

export declare const getOrElse: <A>(onNone: Lazy<T.Task<A>>) => (fa: TaskOption<A>) => T.Task<A>

Added in v2.10.0

getOrElseW

Less strict version of getOrElse.

Signature

export declare const getOrElseW: <B>(onNone: Lazy<T.Task<B>>) => <A>(ma: TaskOption<A>) => T.Task<B | A>

Added in v2.10.0

match

Signature

export declare const match: <B, A>(onNone: () => B, onSome: (a: A) => B) => (ma: TaskOption<A>) => T.Task<B>

Added in v2.10.0

matchE

Signature

export declare const matchE: <B, A>(
  onNone: () => T.Task<B>,
  onSome: (a: A) => T.Task<B>
) => (ma: TaskOption<A>) => T.Task<B>

Added in v2.10.0

matchEW

Less strict version of matchE.

Signature

export declare const matchEW: <B, C, A>(
  onNone: () => T.Task<B>,
  onSome: (a: A) => T.Task<C>
) => (ma: TaskOption<A>) => T.Task<B | C>

Added in v2.10.0

matchW

Less strict version of match.

Signature

export declare const matchW: <B, A, C>(onNone: () => B, onSome: (a: A) => C) => (ma: TaskOption<A>) => T.Task<B | C>

Added in v2.10.0

instances

Alt

Signature

export declare const Alt: Alt1<'TaskOption'>

Added in v2.10.0

Alternative

Signature

export declare const Alternative: Alternative1<'TaskOption'>

Added in v2.10.0

ApplicativePar

Signature

export declare const ApplicativePar: Applicative1<'TaskOption'>

Added in v2.10.0

ApplicativeSeq

Signature

export declare const ApplicativeSeq: Applicative1<'TaskOption'>

Added in v2.10.0

ApplyPar

Signature

export declare const ApplyPar: Apply1<'TaskOption'>

Added in v2.10.0

ApplySeq

Signature

export declare const ApplySeq: Apply1<'TaskOption'>

Added in v2.10.0

Chain

Signature

export declare const Chain: Chain1<'TaskOption'>

Added in v2.10.0

Compactable

Signature

export declare const Compactable: Compactable1<'TaskOption'>

Added in v2.10.0

Filterable

Signature

export declare const Filterable: Filterable1<'TaskOption'>

Added in v2.10.0

FromIO

Signature

export declare const FromIO: FromIO1<'TaskOption'>

Added in v2.10.0

FromTask

Signature

export declare const FromTask: FromTask1<'TaskOption'>

Added in v2.10.0

Functor

Signature

export declare const Functor: Functor1<'TaskOption'>

Added in v2.10.0

Monad

Signature

export declare const Monad: Monad1<'TaskOption'>

Added in v2.10.0

MonadIO

Signature

export declare const MonadIO: MonadIO1<'TaskOption'>

Added in v2.10.0

MonadTask

Signature

export declare const MonadTask: MonadTask1<'TaskOption'>

Added in v2.10.0

Pointed

Signature

export declare const Pointed: Pointed1<'TaskOption'>

Added in v2.10.0

URI (type alias)

Signature

export type URI = typeof URI

Added in v2.10.0

interop

chainNullableK

Signature

export declare const chainNullableK: <A, B>(
  f: (a: A) => B | null | undefined
) => (ma: TaskOption<A>) => TaskOption<NonNullable<B>>

Added in v2.10.0

fromNullable

Signature

export declare const fromNullable: <A>(a: A) => TaskOption<NonNullable<A>>

Added in v2.10.0

fromNullableK

Signature

export declare const fromNullableK: <A extends readonly unknown[], B>(
  f: (...a: A) => B | null | undefined
) => (...a: A) => TaskOption<NonNullable<B>>

Added in v2.10.0

tryCatch

Transforms a Promise that may reject to a Promise that never rejects and returns an Option instead.

Note: f should never throw errors, they are not caught.

See also tryCatchK.

Signature

export declare const tryCatch: <A>(f: Lazy<Promise<A>>) => TaskOption<A>

Added in v2.10.0

tryCatchK

Converts a function returning a Promise to one returning a TaskOption.

Signature

export declare const tryCatchK: <A extends readonly unknown[], B>(
  f: (...a: A) => Promise<B>
) => (...a: A) => TaskOption<B>

Added in v2.10.0

model

TaskOption (interface)

Signature

export interface TaskOption<A> extends Task<Option<A>> {}

Added in v2.10.0

utils

Do

Signature

export declare const Do: TaskOption<{}>

Added in v2.10.0

apS

Signature

export declare const apS: <N, A, B>(
  name: Exclude<N, keyof A>,
  fb: TaskOption<B>
) => (fa: TaskOption<A>) => TaskOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>

Added in v2.10.0

bind

Signature

export declare const bind: <N, A, B>(
  name: Exclude<N, keyof A>,
  f: (a: A) => TaskOption<B>
) => (ma: TaskOption<A>) => TaskOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>

Added in v2.10.0

bindTo

Signature

export declare const bindTo: <N>(name: N) => <A>(fa: TaskOption<A>) => TaskOption<{ readonly [K in N]: A }>

Added in v2.10.0

sequenceArray

Equivalent to ReadonlyArray#sequence(ApplicativePar).

Signature

export declare const sequenceArray: <A>(as: readonly TaskOption<A>[]) => TaskOption<readonly A[]>

Added in v2.10.0

sequenceSeqArray

Equivalent to ReadonlyArray#sequence(ApplicativeSeq).

Signature

export declare const sequenceSeqArray: <A>(as: readonly TaskOption<A>[]) => TaskOption<readonly A[]>

Added in v2.10.0

traverseArray

Equivalent to ReadonlyArray#traverse(ApplicativePar).

Signature

export declare const traverseArray: <A, B>(f: (a: A) => TaskOption<B>) => (as: readonly A[]) => TaskOption<readonly B[]>

Added in v2.10.0

traverseArrayWithIndex

Equivalent to ReadonlyArray#traverseWithIndex(ApplicativePar).

Signature

export declare const traverseArrayWithIndex: <A, B>(
  f: (index: number, a: A) => TaskOption<B>
) => (as: readonly A[]) => TaskOption<readonly B[]>

Added in v2.10.0

traverseSeqArray

Equivalent to ReadonlyArray#traverse(ApplicativeSeq).

Signature

export declare const traverseSeqArray: <A, B>(
  f: (a: A) => TaskOption<B>
) => (as: readonly A[]) => TaskOption<readonly B[]>

Added in v2.10.0

traverseSeqArrayWithIndex

Equivalent to ReadonlyArray#traverseWithIndex(ApplicativeSeq).

Signature

export declare const traverseSeqArrayWithIndex: <A, B>(
  f: (index: number, a: A) => TaskOption<B>
) => (as: readonly A[]) => TaskOption<readonly B[]>

Added in v2.10.0