From b395762c12cc77d25f98102203eba6ed703ed04e Mon Sep 17 00:00:00 2001 From: gcanti Date: Thu, 21 Apr 2022 16:22:12 +0200 Subject: [PATCH] update docs --- docs/modules/IOEither.ts.md | 2 +- docs/modules/IOOption.ts.md | 886 +++++++++++++++++++++++ docs/modules/IORef.ts.md | 2 +- docs/modules/JoinSemilattice.ts.md | 2 +- docs/modules/Json.ts.md | 2 +- docs/modules/Lattice.ts.md | 2 +- docs/modules/Magma.ts.md | 2 +- docs/modules/Map.ts.md | 2 +- docs/modules/MeetSemilattice.ts.md | 2 +- docs/modules/Monad.ts.md | 2 +- docs/modules/MonadIO.ts.md | 2 +- docs/modules/MonadTask.ts.md | 2 +- docs/modules/MonadThrow.ts.md | 2 +- docs/modules/Monoid.ts.md | 2 +- docs/modules/NaturalTransformation.ts.md | 2 +- docs/modules/NonEmptyArray.ts.md | 2 +- docs/modules/Option.ts.md | 2 +- docs/modules/OptionT.ts.md | 2 +- docs/modules/Ord.ts.md | 2 +- docs/modules/Ordering.ts.md | 2 +- docs/modules/Pointed.ts.md | 2 +- docs/modules/Predicate.ts.md | 2 +- docs/modules/Profunctor.ts.md | 2 +- docs/modules/Random.ts.md | 2 +- docs/modules/Reader.ts.md | 2 +- docs/modules/ReaderEither.ts.md | 2 +- docs/modules/ReaderT.ts.md | 2 +- docs/modules/ReaderTask.ts.md | 2 +- docs/modules/ReaderTaskEither.ts.md | 2 +- docs/modules/ReadonlyArray.ts.md | 2 +- docs/modules/ReadonlyMap.ts.md | 2 +- docs/modules/ReadonlyNonEmptyArray.ts.md | 2 +- docs/modules/ReadonlyRecord.ts.md | 2 +- docs/modules/ReadonlySet.ts.md | 2 +- docs/modules/ReadonlyTuple.ts.md | 2 +- docs/modules/Record.ts.md | 2 +- docs/modules/Refinement.ts.md | 2 +- docs/modules/Ring.ts.md | 2 +- docs/modules/Semigroup.ts.md | 2 +- docs/modules/Semigroupoid.ts.md | 2 +- docs/modules/Semiring.ts.md | 2 +- docs/modules/Separated.ts.md | 2 +- docs/modules/Set.ts.md | 2 +- docs/modules/Show.ts.md | 2 +- docs/modules/State.ts.md | 2 +- docs/modules/StateReaderTaskEither.ts.md | 2 +- docs/modules/StateT.ts.md | 2 +- docs/modules/Store.ts.md | 2 +- docs/modules/Strong.ts.md | 2 +- docs/modules/Task.ts.md | 2 +- docs/modules/TaskEither.ts.md | 6 +- docs/modules/TaskOption.ts.md | 2 +- docs/modules/TaskThese.ts.md | 2 +- docs/modules/These.ts.md | 2 +- docs/modules/TheseT.ts.md | 2 +- docs/modules/Traced.ts.md | 2 +- docs/modules/Traversable.ts.md | 2 +- docs/modules/TraversableWithIndex.ts.md | 2 +- docs/modules/Tree.ts.md | 2 +- docs/modules/Tuple.ts.md | 2 +- docs/modules/Unfoldable.ts.md | 2 +- docs/modules/ValidationT.ts.md | 2 +- docs/modules/Witherable.ts.md | 2 +- docs/modules/Writer.ts.md | 2 +- docs/modules/WriterT.ts.md | 2 +- docs/modules/Zero.ts.md | 2 +- docs/modules/index.ts.md | 11 + docs/modules/number.ts.md | 2 +- docs/modules/pipeable.ts.md | 2 +- docs/modules/string.ts.md | 2 +- docs/modules/struct.ts.md | 2 +- docs/modules/void.ts.md | 2 +- src/IOEither.ts | 2 +- src/TaskEither.ts | 4 +- 74 files changed, 972 insertions(+), 75 deletions(-) create mode 100644 docs/modules/IOOption.ts.md diff --git a/docs/modules/IOEither.ts.md b/docs/modules/IOEither.ts.md index d7274848e..2da74aa93 100644 --- a/docs/modules/IOEither.ts.md +++ b/docs/modules/IOEither.ts.md @@ -582,7 +582,7 @@ Added in v2.11.0 export declare const orElseFirstIOK: (onLeft: (e: E) => I.IO) => (ma: IOEither) => IOEither ``` -Added in v2.11.8 +Added in v2.12.0 ## orElseFirstW diff --git a/docs/modules/IOOption.ts.md b/docs/modules/IOOption.ts.md new file mode 100644 index 000000000..afe3c3484 --- /dev/null +++ b/docs/modules/IOOption.ts.md @@ -0,0 +1,886 @@ +--- +title: IOOption.ts +nav_order: 53 +parent: Modules +--- + +## IOOption overview + +Added in v2.12.0 + +--- + +

Table of contents

+ +- [Alt](#alt) + - [alt](#alt) + - [altW](#altw) +- [Apply](#apply) + - [ap](#ap) +- [Compactable](#compactable) + - [compact](#compact) + - [separate](#separate) +- [Filterable](#filterable) + - [filter](#filter) + - [filterMap](#filtermap) + - [partition](#partition) + - [partitionMap](#partitionmap) +- [Functor](#functor) + - [map](#map) +- [Monad](#monad) + - [chain](#chain) +- [Pointed](#pointed) + - [of](#of) +- [Zero](#zero) + - [zero](#zero) +- [combinators](#combinators) + - [apFirst](#apfirst) + - [apSecond](#apsecond) + - [chainEitherK](#chaineitherk) + - [chainFirst](#chainfirst) + - [chainFirstEitherK](#chainfirsteitherk) + - [chainFirstIOK](#chainfirstiok) + - [chainIOK](#chainiok) + - [chainOptionK](#chainoptionk) + - [flap](#flap) + - [flatten](#flatten) + - [fromEitherK](#fromeitherk) + - [fromIOK](#fromiok) + - [fromOptionK](#fromoptionk) +- [constructors](#constructors) + - [fromPredicate](#frompredicate) + - [guard](#guard) + - [none](#none) + - [some](#some) +- [destructors](#destructors) + - [fold](#fold) + - [getOrElse](#getorelse) + - [getOrElseW](#getorelsew) + - [match](#match) + - [matchE](#matche) + - [matchEW](#matchew) + - [matchW](#matchw) + - [toNullable](#tonullable) + - [toUndefined](#toundefined) +- [instances](#instances) + - [Alt](#alt-1) + - [Alternative](#alternative) + - [Applicative](#applicative) + - [Apply](#apply-1) + - [Chain](#chain) + - [Compactable](#compactable-1) + - [Filterable](#filterable-1) + - [FromEither](#fromeither) + - [FromIO](#fromio) + - [Functor](#functor-1) + - [Monad](#monad-1) + - [MonadIO](#monadio) + - [Pointed](#pointed-1) + - [URI (type alias)](#uri-type-alias) + - [Zero](#zero-1) +- [interop](#interop) + - [chainNullableK](#chainnullablek) + - [fromNullable](#fromnullable) + - [fromNullableK](#fromnullablek) +- [model](#model) + - [IOOption (interface)](#iooption-interface) +- [natural transformations](#natural-transformations) + - [fromEither](#fromeither) + - [fromIO](#fromio) + - [fromIOEither](#fromioeither) + - [fromOption](#fromoption) +- [utils](#utils) + - [ApT](#apt) + - [Do](#do) + - [apS](#aps) + - [bind](#bind) + - [bindTo](#bindto) + - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) + - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) + +--- + +# Alt + +## alt + +**Signature** + +```ts +export declare const alt: (second: Lazy>) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## altW + +Less strict version of [`alt`](#alt). + +**Signature** + +```ts +export declare const altW: (second: Lazy>) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +# Apply + +## ap + +**Signature** + +```ts +export declare const ap: (fa: IOOption) => (fab: IOOption<(a: A) => B>) => IOOption +``` + +Added in v2.12.0 + +# Compactable + +## compact + +**Signature** + +```ts +export declare const compact: (fa: IOOption>) => IOOption +``` + +Added in v2.12.0 + +## separate + +**Signature** + +```ts +export declare const separate: (fa: IOOption>) => Separated, IOOption> +``` + +Added in v2.12.0 + +# Filterable + +## filter + +**Signature** + +```ts +export declare const filter: { + (refinement: Refinement): (fb: IOOption) => IOOption + (predicate: Predicate): (fb: IOOption) => IOOption + (predicate: Predicate): (fa: IOOption) => IOOption +} +``` + +Added in v2.12.0 + +## filterMap + +**Signature** + +```ts +export declare const filterMap: (f: (a: A) => O.Option) => (fga: IOOption) => IOOption +``` + +Added in v2.12.0 + +## partition + +**Signature** + +```ts +export declare const partition: { + (refinement: Refinement): (fb: IOOption) => Separated, IOOption> + (predicate: Predicate): (fb: IOOption) => Separated, IOOption> + (predicate: Predicate): (fa: IOOption) => Separated, IOOption> +} +``` + +Added in v2.12.0 + +## partitionMap + +**Signature** + +```ts +export declare const partitionMap: ( + f: (a: A) => Either +) => (fa: IOOption) => Separated, IOOption> +``` + +Added in v2.12.0 + +# Functor + +## map + +`map` can be used to turn functions `(a: A) => B` into functions `(fa: F) => F` whose argument and return types +use the type constructor `F` to represent some computational context. + +**Signature** + +```ts +export declare const map: (f: (a: A) => B) => (fa: IOOption) => IOOption +``` + +Added in v2.12.0 + +# Monad + +## chain + +**Signature** + +```ts +export declare const chain: (f: (a: A) => IOOption) => (ma: IOOption) => IOOption +``` + +Added in v2.12.0 + +# Pointed + +## of + +**Signature** + +```ts +export declare const of: (a: A) => IOOption +``` + +Added in v2.12.0 + +# Zero + +## zero + +**Signature** + +```ts +export declare const zero: () => IOOption +``` + +Added in v2.12.0 + +# combinators + +## apFirst + +Combine two effectful actions, keeping only the result of the first. + +Derivable from `Apply`. + +**Signature** + +```ts +export declare const apFirst: (second: IOOption) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## apSecond + +Combine two effectful actions, keeping only the result of the second. + +Derivable from `Apply`. + +**Signature** + +```ts +export declare const apSecond: (second: IOOption) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## chainEitherK + +**Signature** + +```ts +export declare const chainEitherK: (f: (a: A) => Either) => (ma: IOOption) => IOOption +``` + +Added in v2.12.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** + +```ts +export declare const chainFirst: (f: (a: A) => IOOption) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## chainFirstEitherK + +**Signature** + +```ts +export declare const chainFirstEitherK: (f: (a: A) => Either) => (ma: IOOption) => IOOption +``` + +Added in v2.12.0 + +## chainFirstIOK + +**Signature** + +```ts +export declare const chainFirstIOK: (f: (a: A) => I.IO) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## chainIOK + +**Signature** + +```ts +export declare const chainIOK: (f: (a: A) => I.IO) => (first: IOOption) => IOOption +``` + +Added in v2.12.0 + +## chainOptionK + +**Signature** + +```ts +export declare const chainOptionK: (f: (a: A) => O.Option) => (ma: IOOption) => IOOption +``` + +Added in v2.12.0 + +## flap + +Derivable from `Functor`. + +**Signature** + +```ts +export declare const flap: (a: A) => (fab: IOOption<(a: A) => B>) => IOOption +``` + +Added in v2.12.0 + +## flatten + +Derivable from `Chain`. + +**Signature** + +```ts +export declare const flatten: (mma: IOOption>) => IOOption +``` + +Added in v2.12.0 + +## fromEitherK + +**Signature** + +```ts +export declare const fromEitherK: (f: (...a: A) => Either) => (...a: A) => IOOption +``` + +Added in v2.12.0 + +## fromIOK + +**Signature** + +```ts +export declare const fromIOK: (f: (...a: A) => I.IO) => (...a: A) => IOOption +``` + +Added in v2.12.0 + +## fromOptionK + +**Signature** + +```ts +export declare const fromOptionK: ( + f: (...a: A) => O.Option +) => (...a: A) => IOOption +``` + +Added in v2.12.0 + +# constructors + +## fromPredicate + +**Signature** + +```ts +export declare const fromPredicate: { + (refinement: Refinement): (a: A) => IOOption + (predicate: Predicate): (b: B) => IOOption + (predicate: Predicate): (a: A) => IOOption +} +``` + +Added in v2.12.0 + +## guard + +**Signature** + +```ts +export declare const guard: (b: boolean) => IOOption +``` + +Added in v2.12.0 + +## none + +**Signature** + +```ts +export declare const none: IOOption +``` + +Added in v2.12.0 + +## some + +**Signature** + +```ts +export declare const some: (a: A) => IOOption +``` + +Added in v2.12.0 + +# destructors + +## fold + +Alias of [`matchE`](#matche). + +**Signature** + +```ts +export declare const fold: (onNone: () => I.IO, onSome: (a: A) => I.IO) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## getOrElse + +**Signature** + +```ts +export declare const getOrElse: (onNone: Lazy>) => (fa: IOOption) => I.IO +``` + +Added in v2.12.0 + +## getOrElseW + +Less strict version of [`getOrElse`](#getorelse). + +**Signature** + +```ts +export declare const getOrElseW: (onNone: Lazy>) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## match + +**Signature** + +```ts +export declare const match: (onNone: () => B, onSome: (a: A) => B) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## matchE + +**Signature** + +```ts +export declare const matchE: (onNone: () => I.IO, onSome: (a: A) => I.IO) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## matchEW + +Less strict version of [`matchE`](#matche). + +**Signature** + +```ts +export declare const matchEW: ( + onNone: () => I.IO, + onSome: (a: A) => I.IO +) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## matchW + +Less strict version of [`match`](#match). + +**Signature** + +```ts +export declare const matchW: (onNone: () => B, onSome: (a: A) => C) => (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## toNullable + +**Signature** + +```ts +export declare const toNullable: (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +## toUndefined + +**Signature** + +```ts +export declare const toUndefined: (ma: IOOption) => I.IO +``` + +Added in v2.12.0 + +# instances + +## Alt + +**Signature** + +```ts +export declare const Alt: Alt1<'IOOption'> +``` + +Added in v2.12.0 + +## Alternative + +**Signature** + +```ts +export declare const Alternative: Alternative1<'IOOption'> +``` + +Added in v2.12.0 + +## Applicative + +**Signature** + +```ts +export declare const Applicative: Applicative1<'IOOption'> +``` + +Added in v2.12.0 + +## Apply + +**Signature** + +```ts +export declare const Apply: Apply1<'IOOption'> +``` + +Added in v2.12.0 + +## Chain + +**Signature** + +```ts +export declare const Chain: Chain1<'IOOption'> +``` + +Added in v2.12.0 + +## Compactable + +**Signature** + +```ts +export declare const Compactable: Compactable1<'IOOption'> +``` + +Added in v2.12.0 + +## Filterable + +**Signature** + +```ts +export declare const Filterable: Filterable1<'IOOption'> +``` + +Added in v2.12.0 + +## FromEither + +**Signature** + +```ts +export declare const FromEither: FromEither1<'IOOption'> +``` + +Added in v2.12.0 + +## FromIO + +**Signature** + +```ts +export declare const FromIO: FromIO1<'IOOption'> +``` + +Added in v2.12.0 + +## Functor + +**Signature** + +```ts +export declare const Functor: Functor1<'IOOption'> +``` + +Added in v2.12.0 + +## Monad + +**Signature** + +```ts +export declare const Monad: Monad1<'IOOption'> +``` + +Added in v2.12.0 + +## MonadIO + +**Signature** + +```ts +export declare const MonadIO: MonadIO1<'IOOption'> +``` + +Added in v2.12.0 + +## Pointed + +**Signature** + +```ts +export declare const Pointed: Pointed1<'IOOption'> +``` + +Added in v2.12.0 + +## URI (type alias) + +**Signature** + +```ts +export type URI = typeof URI +``` + +Added in v2.12.0 + +## Zero + +**Signature** + +```ts +export declare const Zero: Zero1<'IOOption'> +``` + +Added in v2.12.0 + +# interop + +## chainNullableK + +**Signature** + +```ts +export declare const chainNullableK: ( + f: (a: A) => B | null | undefined +) => (ma: IOOption) => IOOption> +``` + +Added in v2.12.0 + +## fromNullable + +**Signature** + +```ts +export declare const fromNullable: (a: A) => IOOption> +``` + +Added in v2.12.0 + +## fromNullableK + +**Signature** + +```ts +export declare const fromNullableK: ( + f: (...a: A) => B | null | undefined +) => (...a: A) => IOOption> +``` + +Added in v2.12.0 + +# model + +## IOOption (interface) + +**Signature** + +```ts +export interface IOOption extends IO> {} +``` + +Added in v2.12.0 + +# natural transformations + +## fromEither + +**Signature** + +```ts +export declare const fromEither: NaturalTransformation21<'Either', 'IOOption'> +``` + +Added in v2.12.0 + +## fromIO + +**Signature** + +```ts +export declare const fromIO: NaturalTransformation11<'IO', 'IOOption'> +``` + +Added in v2.12.0 + +## fromIOEither + +**Signature** + +```ts +export declare const fromIOEither: NaturalTransformation21<'IOEither', 'IOOption'> +``` + +Added in v2.12.0 + +## fromOption + +**Signature** + +```ts +export declare const fromOption: NaturalTransformation11<'Option', 'IOOption'> +``` + +Added in v2.12.0 + +# utils + +## ApT + +**Signature** + +```ts +export declare const ApT: IOOption +``` + +Added in v2.12.0 + +## Do + +**Signature** + +```ts +export declare const Do: IOOption<{}> +``` + +Added in v2.12.0 + +## apS + +**Signature** + +```ts +export declare const apS: ( + name: Exclude, + fb: IOOption +) => (fa: IOOption) => IOOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }> +``` + +Added in v2.12.0 + +## bind + +**Signature** + +```ts +export declare const bind: ( + name: Exclude, + f: (a: A) => IOOption +) => (ma: IOOption) => IOOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }> +``` + +Added in v2.12.0 + +## bindTo + +**Signature** + +```ts +export declare const bindTo: (name: N) => (fa: IOOption) => IOOption<{ readonly [K in N]: A }> +``` + +Added in v2.12.0 + +## traverseReadonlyArrayWithIndex + +**Signature** + +```ts +export declare const traverseReadonlyArrayWithIndex: ( + f: (index: number, a: A) => IOOption +) => (as: readonly A[]) => IOOption +``` + +Added in v2.12.0 + +## traverseReadonlyNonEmptyArrayWithIndex + +**Signature** + +```ts +export declare const traverseReadonlyNonEmptyArrayWithIndex: ( + f: (index: number, a: A) => IOOption +) => (as: ReadonlyNonEmptyArray) => IOOption> +``` + +Added in v2.12.0 diff --git a/docs/modules/IORef.ts.md b/docs/modules/IORef.ts.md index 91ce43431..e60020c27 100644 --- a/docs/modules/IORef.ts.md +++ b/docs/modules/IORef.ts.md @@ -1,6 +1,6 @@ --- title: IORef.ts -nav_order: 53 +nav_order: 54 parent: Modules --- diff --git a/docs/modules/JoinSemilattice.ts.md b/docs/modules/JoinSemilattice.ts.md index 9c808f292..a1e3008ac 100644 --- a/docs/modules/JoinSemilattice.ts.md +++ b/docs/modules/JoinSemilattice.ts.md @@ -1,6 +1,6 @@ --- title: JoinSemilattice.ts -nav_order: 54 +nav_order: 55 parent: Modules --- diff --git a/docs/modules/Json.ts.md b/docs/modules/Json.ts.md index 2ecbffff8..4b07e6e56 100644 --- a/docs/modules/Json.ts.md +++ b/docs/modules/Json.ts.md @@ -1,6 +1,6 @@ --- title: Json.ts -nav_order: 55 +nav_order: 56 parent: Modules --- diff --git a/docs/modules/Lattice.ts.md b/docs/modules/Lattice.ts.md index 0bd0479d3..3a792b67a 100644 --- a/docs/modules/Lattice.ts.md +++ b/docs/modules/Lattice.ts.md @@ -1,6 +1,6 @@ --- title: Lattice.ts -nav_order: 56 +nav_order: 57 parent: Modules --- diff --git a/docs/modules/Magma.ts.md b/docs/modules/Magma.ts.md index 8664a12a1..4bfa01e66 100644 --- a/docs/modules/Magma.ts.md +++ b/docs/modules/Magma.ts.md @@ -1,6 +1,6 @@ --- title: Magma.ts -nav_order: 57 +nav_order: 58 parent: Modules --- diff --git a/docs/modules/Map.ts.md b/docs/modules/Map.ts.md index 03af530f9..483ea1654 100644 --- a/docs/modules/Map.ts.md +++ b/docs/modules/Map.ts.md @@ -1,6 +1,6 @@ --- title: Map.ts -nav_order: 58 +nav_order: 59 parent: Modules --- diff --git a/docs/modules/MeetSemilattice.ts.md b/docs/modules/MeetSemilattice.ts.md index e100614df..677c4daed 100644 --- a/docs/modules/MeetSemilattice.ts.md +++ b/docs/modules/MeetSemilattice.ts.md @@ -1,6 +1,6 @@ --- title: MeetSemilattice.ts -nav_order: 59 +nav_order: 60 parent: Modules --- diff --git a/docs/modules/Monad.ts.md b/docs/modules/Monad.ts.md index 8981f3fd8..a8825d4ec 100644 --- a/docs/modules/Monad.ts.md +++ b/docs/modules/Monad.ts.md @@ -1,6 +1,6 @@ --- title: Monad.ts -nav_order: 60 +nav_order: 61 parent: Modules --- diff --git a/docs/modules/MonadIO.ts.md b/docs/modules/MonadIO.ts.md index 111cb30cc..b05932b3a 100644 --- a/docs/modules/MonadIO.ts.md +++ b/docs/modules/MonadIO.ts.md @@ -1,6 +1,6 @@ --- title: MonadIO.ts -nav_order: 61 +nav_order: 62 parent: Modules --- diff --git a/docs/modules/MonadTask.ts.md b/docs/modules/MonadTask.ts.md index 14cb07bfc..f8854f945 100644 --- a/docs/modules/MonadTask.ts.md +++ b/docs/modules/MonadTask.ts.md @@ -1,6 +1,6 @@ --- title: MonadTask.ts -nav_order: 62 +nav_order: 63 parent: Modules --- diff --git a/docs/modules/MonadThrow.ts.md b/docs/modules/MonadThrow.ts.md index f0cd5aee4..dcc56b8d9 100644 --- a/docs/modules/MonadThrow.ts.md +++ b/docs/modules/MonadThrow.ts.md @@ -1,6 +1,6 @@ --- title: MonadThrow.ts -nav_order: 63 +nav_order: 64 parent: Modules --- diff --git a/docs/modules/Monoid.ts.md b/docs/modules/Monoid.ts.md index d73c07e41..0a0e03cc9 100644 --- a/docs/modules/Monoid.ts.md +++ b/docs/modules/Monoid.ts.md @@ -1,6 +1,6 @@ --- title: Monoid.ts -nav_order: 64 +nav_order: 65 parent: Modules --- diff --git a/docs/modules/NaturalTransformation.ts.md b/docs/modules/NaturalTransformation.ts.md index 5494652e9..f3450243a 100644 --- a/docs/modules/NaturalTransformation.ts.md +++ b/docs/modules/NaturalTransformation.ts.md @@ -1,6 +1,6 @@ --- title: NaturalTransformation.ts -nav_order: 65 +nav_order: 66 parent: Modules --- diff --git a/docs/modules/NonEmptyArray.ts.md b/docs/modules/NonEmptyArray.ts.md index 2a9e3116f..4c96c220b 100644 --- a/docs/modules/NonEmptyArray.ts.md +++ b/docs/modules/NonEmptyArray.ts.md @@ -1,6 +1,6 @@ --- title: NonEmptyArray.ts -nav_order: 66 +nav_order: 67 parent: Modules --- diff --git a/docs/modules/Option.ts.md b/docs/modules/Option.ts.md index 0d993b14f..101628e2d 100644 --- a/docs/modules/Option.ts.md +++ b/docs/modules/Option.ts.md @@ -1,6 +1,6 @@ --- title: Option.ts -nav_order: 68 +nav_order: 69 parent: Modules --- diff --git a/docs/modules/OptionT.ts.md b/docs/modules/OptionT.ts.md index 9852126ef..b7e97f8f7 100644 --- a/docs/modules/OptionT.ts.md +++ b/docs/modules/OptionT.ts.md @@ -1,6 +1,6 @@ --- title: OptionT.ts -nav_order: 69 +nav_order: 70 parent: Modules --- diff --git a/docs/modules/Ord.ts.md b/docs/modules/Ord.ts.md index 148a4d525..b16ee459d 100644 --- a/docs/modules/Ord.ts.md +++ b/docs/modules/Ord.ts.md @@ -1,6 +1,6 @@ --- title: Ord.ts -nav_order: 70 +nav_order: 71 parent: Modules --- diff --git a/docs/modules/Ordering.ts.md b/docs/modules/Ordering.ts.md index b2d67e09d..e8741de07 100644 --- a/docs/modules/Ordering.ts.md +++ b/docs/modules/Ordering.ts.md @@ -1,6 +1,6 @@ --- title: Ordering.ts -nav_order: 71 +nav_order: 72 parent: Modules --- diff --git a/docs/modules/Pointed.ts.md b/docs/modules/Pointed.ts.md index 1ad51985a..0b05bd882 100644 --- a/docs/modules/Pointed.ts.md +++ b/docs/modules/Pointed.ts.md @@ -1,6 +1,6 @@ --- title: Pointed.ts -nav_order: 73 +nav_order: 74 parent: Modules --- diff --git a/docs/modules/Predicate.ts.md b/docs/modules/Predicate.ts.md index fad120be6..ac65846c5 100644 --- a/docs/modules/Predicate.ts.md +++ b/docs/modules/Predicate.ts.md @@ -1,6 +1,6 @@ --- title: Predicate.ts -nav_order: 74 +nav_order: 75 parent: Modules --- diff --git a/docs/modules/Profunctor.ts.md b/docs/modules/Profunctor.ts.md index 9ca9d754d..dc66d8b02 100644 --- a/docs/modules/Profunctor.ts.md +++ b/docs/modules/Profunctor.ts.md @@ -1,6 +1,6 @@ --- title: Profunctor.ts -nav_order: 75 +nav_order: 76 parent: Modules --- diff --git a/docs/modules/Random.ts.md b/docs/modules/Random.ts.md index c87b9fccb..3dcc52e3b 100644 --- a/docs/modules/Random.ts.md +++ b/docs/modules/Random.ts.md @@ -1,6 +1,6 @@ --- title: Random.ts -nav_order: 76 +nav_order: 77 parent: Modules --- diff --git a/docs/modules/Reader.ts.md b/docs/modules/Reader.ts.md index d5ff9a71c..537db8bca 100644 --- a/docs/modules/Reader.ts.md +++ b/docs/modules/Reader.ts.md @@ -1,6 +1,6 @@ --- title: Reader.ts -nav_order: 77 +nav_order: 78 parent: Modules --- diff --git a/docs/modules/ReaderEither.ts.md b/docs/modules/ReaderEither.ts.md index e5b9c1a50..60f252083 100644 --- a/docs/modules/ReaderEither.ts.md +++ b/docs/modules/ReaderEither.ts.md @@ -1,6 +1,6 @@ --- title: ReaderEither.ts -nav_order: 78 +nav_order: 79 parent: Modules --- diff --git a/docs/modules/ReaderT.ts.md b/docs/modules/ReaderT.ts.md index 4c7be6477..97a97aa9a 100644 --- a/docs/modules/ReaderT.ts.md +++ b/docs/modules/ReaderT.ts.md @@ -1,6 +1,6 @@ --- title: ReaderT.ts -nav_order: 79 +nav_order: 80 parent: Modules --- diff --git a/docs/modules/ReaderTask.ts.md b/docs/modules/ReaderTask.ts.md index 005b1d080..7c141ac39 100644 --- a/docs/modules/ReaderTask.ts.md +++ b/docs/modules/ReaderTask.ts.md @@ -1,6 +1,6 @@ --- title: ReaderTask.ts -nav_order: 80 +nav_order: 81 parent: Modules --- diff --git a/docs/modules/ReaderTaskEither.ts.md b/docs/modules/ReaderTaskEither.ts.md index 43edd6202..08a8c0361 100644 --- a/docs/modules/ReaderTaskEither.ts.md +++ b/docs/modules/ReaderTaskEither.ts.md @@ -1,6 +1,6 @@ --- title: ReaderTaskEither.ts -nav_order: 81 +nav_order: 82 parent: Modules --- diff --git a/docs/modules/ReadonlyArray.ts.md b/docs/modules/ReadonlyArray.ts.md index 4df77327b..bec84cfcd 100644 --- a/docs/modules/ReadonlyArray.ts.md +++ b/docs/modules/ReadonlyArray.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlyArray.ts -nav_order: 82 +nav_order: 83 parent: Modules --- diff --git a/docs/modules/ReadonlyMap.ts.md b/docs/modules/ReadonlyMap.ts.md index 5b025a855..30997caa4 100644 --- a/docs/modules/ReadonlyMap.ts.md +++ b/docs/modules/ReadonlyMap.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlyMap.ts -nav_order: 83 +nav_order: 84 parent: Modules --- diff --git a/docs/modules/ReadonlyNonEmptyArray.ts.md b/docs/modules/ReadonlyNonEmptyArray.ts.md index 51232b8bb..7b746916d 100644 --- a/docs/modules/ReadonlyNonEmptyArray.ts.md +++ b/docs/modules/ReadonlyNonEmptyArray.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlyNonEmptyArray.ts -nav_order: 84 +nav_order: 85 parent: Modules --- diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md index d526a5576..9308b51a5 100644 --- a/docs/modules/ReadonlyRecord.ts.md +++ b/docs/modules/ReadonlyRecord.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlyRecord.ts -nav_order: 85 +nav_order: 86 parent: Modules --- diff --git a/docs/modules/ReadonlySet.ts.md b/docs/modules/ReadonlySet.ts.md index 522bc59dc..fc70ec870 100644 --- a/docs/modules/ReadonlySet.ts.md +++ b/docs/modules/ReadonlySet.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlySet.ts -nav_order: 86 +nav_order: 87 parent: Modules --- diff --git a/docs/modules/ReadonlyTuple.ts.md b/docs/modules/ReadonlyTuple.ts.md index a3834ef05..e9abc3aed 100644 --- a/docs/modules/ReadonlyTuple.ts.md +++ b/docs/modules/ReadonlyTuple.ts.md @@ -1,6 +1,6 @@ --- title: ReadonlyTuple.ts -nav_order: 87 +nav_order: 88 parent: Modules --- diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md index fe7781470..d29a061d1 100644 --- a/docs/modules/Record.ts.md +++ b/docs/modules/Record.ts.md @@ -1,6 +1,6 @@ --- title: Record.ts -nav_order: 88 +nav_order: 89 parent: Modules --- diff --git a/docs/modules/Refinement.ts.md b/docs/modules/Refinement.ts.md index 6672377d0..b7ca3686d 100644 --- a/docs/modules/Refinement.ts.md +++ b/docs/modules/Refinement.ts.md @@ -1,6 +1,6 @@ --- title: Refinement.ts -nav_order: 89 +nav_order: 90 parent: Modules --- diff --git a/docs/modules/Ring.ts.md b/docs/modules/Ring.ts.md index 375f25e2b..a973c1b3e 100644 --- a/docs/modules/Ring.ts.md +++ b/docs/modules/Ring.ts.md @@ -1,6 +1,6 @@ --- title: Ring.ts -nav_order: 90 +nav_order: 91 parent: Modules --- diff --git a/docs/modules/Semigroup.ts.md b/docs/modules/Semigroup.ts.md index 9193ee3d7..7d953d13d 100644 --- a/docs/modules/Semigroup.ts.md +++ b/docs/modules/Semigroup.ts.md @@ -1,6 +1,6 @@ --- title: Semigroup.ts -nav_order: 91 +nav_order: 92 parent: Modules --- diff --git a/docs/modules/Semigroupoid.ts.md b/docs/modules/Semigroupoid.ts.md index 3324c3671..aabd526fa 100644 --- a/docs/modules/Semigroupoid.ts.md +++ b/docs/modules/Semigroupoid.ts.md @@ -1,6 +1,6 @@ --- title: Semigroupoid.ts -nav_order: 92 +nav_order: 93 parent: Modules --- diff --git a/docs/modules/Semiring.ts.md b/docs/modules/Semiring.ts.md index 0e0eaf7c3..afd34c7e3 100644 --- a/docs/modules/Semiring.ts.md +++ b/docs/modules/Semiring.ts.md @@ -1,6 +1,6 @@ --- title: Semiring.ts -nav_order: 93 +nav_order: 94 parent: Modules --- diff --git a/docs/modules/Separated.ts.md b/docs/modules/Separated.ts.md index 2674767f6..b485e6abe 100644 --- a/docs/modules/Separated.ts.md +++ b/docs/modules/Separated.ts.md @@ -1,6 +1,6 @@ --- title: Separated.ts -nav_order: 94 +nav_order: 95 parent: Modules --- diff --git a/docs/modules/Set.ts.md b/docs/modules/Set.ts.md index 0307552ab..724a6a690 100644 --- a/docs/modules/Set.ts.md +++ b/docs/modules/Set.ts.md @@ -1,6 +1,6 @@ --- title: Set.ts -nav_order: 95 +nav_order: 96 parent: Modules --- diff --git a/docs/modules/Show.ts.md b/docs/modules/Show.ts.md index f3474685d..bd2e5e7be 100644 --- a/docs/modules/Show.ts.md +++ b/docs/modules/Show.ts.md @@ -1,6 +1,6 @@ --- title: Show.ts -nav_order: 96 +nav_order: 97 parent: Modules --- diff --git a/docs/modules/State.ts.md b/docs/modules/State.ts.md index 1d693d443..23e32b823 100644 --- a/docs/modules/State.ts.md +++ b/docs/modules/State.ts.md @@ -1,6 +1,6 @@ --- title: State.ts -nav_order: 97 +nav_order: 98 parent: Modules --- diff --git a/docs/modules/StateReaderTaskEither.ts.md b/docs/modules/StateReaderTaskEither.ts.md index f91c7f0ff..a1a59f956 100644 --- a/docs/modules/StateReaderTaskEither.ts.md +++ b/docs/modules/StateReaderTaskEither.ts.md @@ -1,6 +1,6 @@ --- title: StateReaderTaskEither.ts -nav_order: 98 +nav_order: 99 parent: Modules --- diff --git a/docs/modules/StateT.ts.md b/docs/modules/StateT.ts.md index 5c29b02f3..02c7b7571 100644 --- a/docs/modules/StateT.ts.md +++ b/docs/modules/StateT.ts.md @@ -1,6 +1,6 @@ --- title: StateT.ts -nav_order: 99 +nav_order: 100 parent: Modules --- diff --git a/docs/modules/Store.ts.md b/docs/modules/Store.ts.md index a8e43179b..3ef198f4e 100644 --- a/docs/modules/Store.ts.md +++ b/docs/modules/Store.ts.md @@ -1,6 +1,6 @@ --- title: Store.ts -nav_order: 100 +nav_order: 101 parent: Modules --- diff --git a/docs/modules/Strong.ts.md b/docs/modules/Strong.ts.md index c331116dd..7812e4985 100644 --- a/docs/modules/Strong.ts.md +++ b/docs/modules/Strong.ts.md @@ -1,6 +1,6 @@ --- title: Strong.ts -nav_order: 102 +nav_order: 103 parent: Modules --- diff --git a/docs/modules/Task.ts.md b/docs/modules/Task.ts.md index 6e05a21dd..fa73a4266 100644 --- a/docs/modules/Task.ts.md +++ b/docs/modules/Task.ts.md @@ -1,6 +1,6 @@ --- title: Task.ts -nav_order: 104 +nav_order: 105 parent: Modules --- diff --git a/docs/modules/TaskEither.ts.md b/docs/modules/TaskEither.ts.md index 05a2aaaa6..044507055 100644 --- a/docs/modules/TaskEither.ts.md +++ b/docs/modules/TaskEither.ts.md @@ -1,6 +1,6 @@ --- title: TaskEither.ts -nav_order: 105 +nav_order: 106 parent: Modules --- @@ -764,7 +764,7 @@ Added in v2.11.0 export declare const orElseFirstIOK: (onLeft: (e: E) => IO) => (ma: TaskEither) => TaskEither ``` -Added in v2.11.8 +Added in v2.12.0 ## orElseFirstTaskK @@ -776,7 +776,7 @@ export declare const orElseFirstTaskK: ( ) => (ma: TaskEither) => TaskEither ``` -Added in v2.11.8 +Added in v2.12.0 ## orElseFirstW diff --git a/docs/modules/TaskOption.ts.md b/docs/modules/TaskOption.ts.md index 7b91db4a5..ca8d1d2f3 100644 --- a/docs/modules/TaskOption.ts.md +++ b/docs/modules/TaskOption.ts.md @@ -1,6 +1,6 @@ --- title: TaskOption.ts -nav_order: 106 +nav_order: 107 parent: Modules --- diff --git a/docs/modules/TaskThese.ts.md b/docs/modules/TaskThese.ts.md index 44f336bf4..96340eb93 100644 --- a/docs/modules/TaskThese.ts.md +++ b/docs/modules/TaskThese.ts.md @@ -1,6 +1,6 @@ --- title: TaskThese.ts -nav_order: 107 +nav_order: 108 parent: Modules --- diff --git a/docs/modules/These.ts.md b/docs/modules/These.ts.md index 7c8773eb1..7241f4b0c 100644 --- a/docs/modules/These.ts.md +++ b/docs/modules/These.ts.md @@ -1,6 +1,6 @@ --- title: These.ts -nav_order: 108 +nav_order: 109 parent: Modules --- diff --git a/docs/modules/TheseT.ts.md b/docs/modules/TheseT.ts.md index b4d5191da..a9875224d 100644 --- a/docs/modules/TheseT.ts.md +++ b/docs/modules/TheseT.ts.md @@ -1,6 +1,6 @@ --- title: TheseT.ts -nav_order: 109 +nav_order: 110 parent: Modules --- diff --git a/docs/modules/Traced.ts.md b/docs/modules/Traced.ts.md index a05b493b2..fdee1b906 100644 --- a/docs/modules/Traced.ts.md +++ b/docs/modules/Traced.ts.md @@ -1,6 +1,6 @@ --- title: Traced.ts -nav_order: 110 +nav_order: 111 parent: Modules --- diff --git a/docs/modules/Traversable.ts.md b/docs/modules/Traversable.ts.md index 2eb144792..b95eb0d7a 100644 --- a/docs/modules/Traversable.ts.md +++ b/docs/modules/Traversable.ts.md @@ -1,6 +1,6 @@ --- title: Traversable.ts -nav_order: 111 +nav_order: 112 parent: Modules --- diff --git a/docs/modules/TraversableWithIndex.ts.md b/docs/modules/TraversableWithIndex.ts.md index ca3c5efa8..fe42883f2 100644 --- a/docs/modules/TraversableWithIndex.ts.md +++ b/docs/modules/TraversableWithIndex.ts.md @@ -1,6 +1,6 @@ --- title: TraversableWithIndex.ts -nav_order: 112 +nav_order: 113 parent: Modules --- diff --git a/docs/modules/Tree.ts.md b/docs/modules/Tree.ts.md index 1a2459384..77e7d09de 100644 --- a/docs/modules/Tree.ts.md +++ b/docs/modules/Tree.ts.md @@ -1,6 +1,6 @@ --- title: Tree.ts -nav_order: 113 +nav_order: 114 parent: Modules --- diff --git a/docs/modules/Tuple.ts.md b/docs/modules/Tuple.ts.md index 90d4eb8a1..8ea4ad87c 100644 --- a/docs/modules/Tuple.ts.md +++ b/docs/modules/Tuple.ts.md @@ -1,6 +1,6 @@ --- title: Tuple.ts -nav_order: 114 +nav_order: 115 parent: Modules --- diff --git a/docs/modules/Unfoldable.ts.md b/docs/modules/Unfoldable.ts.md index 5f87adc14..5fc9966e0 100644 --- a/docs/modules/Unfoldable.ts.md +++ b/docs/modules/Unfoldable.ts.md @@ -1,6 +1,6 @@ --- title: Unfoldable.ts -nav_order: 115 +nav_order: 116 parent: Modules --- diff --git a/docs/modules/ValidationT.ts.md b/docs/modules/ValidationT.ts.md index 4214f5ea6..4a8557e2c 100644 --- a/docs/modules/ValidationT.ts.md +++ b/docs/modules/ValidationT.ts.md @@ -1,6 +1,6 @@ --- title: ValidationT.ts -nav_order: 116 +nav_order: 117 parent: Modules --- diff --git a/docs/modules/Witherable.ts.md b/docs/modules/Witherable.ts.md index fa116092d..0715514b2 100644 --- a/docs/modules/Witherable.ts.md +++ b/docs/modules/Witherable.ts.md @@ -1,6 +1,6 @@ --- title: Witherable.ts -nav_order: 118 +nav_order: 119 parent: Modules --- diff --git a/docs/modules/Writer.ts.md b/docs/modules/Writer.ts.md index 892b9657f..7e2ee0ef0 100644 --- a/docs/modules/Writer.ts.md +++ b/docs/modules/Writer.ts.md @@ -1,6 +1,6 @@ --- title: Writer.ts -nav_order: 119 +nav_order: 120 parent: Modules --- diff --git a/docs/modules/WriterT.ts.md b/docs/modules/WriterT.ts.md index 5f9e57f0e..559f4b5f6 100644 --- a/docs/modules/WriterT.ts.md +++ b/docs/modules/WriterT.ts.md @@ -1,6 +1,6 @@ --- title: WriterT.ts -nav_order: 120 +nav_order: 121 parent: Modules --- diff --git a/docs/modules/Zero.ts.md b/docs/modules/Zero.ts.md index a218ad433..75c6b9290 100644 --- a/docs/modules/Zero.ts.md +++ b/docs/modules/Zero.ts.md @@ -1,6 +1,6 @@ --- title: Zero.ts -nav_order: 121 +nav_order: 122 parent: Modules --- diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md index 3dcca3664..f834e4c13 100644 --- a/docs/modules/index.ts.md +++ b/docs/modules/index.ts.md @@ -63,6 +63,7 @@ Added in v2.0.0 - [invariant](#invariant) - [io](#io) - [ioEither](#ioeither) + - [ioOption](#iooption) - [ioRef](#ioref) - [joinSemilattice](#joinsemilattice) - [json](#json) @@ -637,6 +638,16 @@ export declare const ioEither: typeof ioEither Added in v2.0.0 +## ioOption + +**Signature** + +```ts +export declare const ioOption: typeof ioOption +``` + +Added in v2.12.0 + ## ioRef **Signature** diff --git a/docs/modules/number.ts.md b/docs/modules/number.ts.md index bef10770a..dcc36e9f3 100644 --- a/docs/modules/number.ts.md +++ b/docs/modules/number.ts.md @@ -1,6 +1,6 @@ --- title: number.ts -nav_order: 67 +nav_order: 68 parent: Modules --- diff --git a/docs/modules/pipeable.ts.md b/docs/modules/pipeable.ts.md index 351bed304..bc4d40867 100644 --- a/docs/modules/pipeable.ts.md +++ b/docs/modules/pipeable.ts.md @@ -1,6 +1,6 @@ --- title: pipeable.ts -nav_order: 72 +nav_order: 73 parent: Modules --- diff --git a/docs/modules/string.ts.md b/docs/modules/string.ts.md index dab82a8ae..805a34f6b 100644 --- a/docs/modules/string.ts.md +++ b/docs/modules/string.ts.md @@ -1,6 +1,6 @@ --- title: string.ts -nav_order: 101 +nav_order: 102 parent: Modules --- diff --git a/docs/modules/struct.ts.md b/docs/modules/struct.ts.md index a85036956..f2cefab4f 100644 --- a/docs/modules/struct.ts.md +++ b/docs/modules/struct.ts.md @@ -1,6 +1,6 @@ --- title: struct.ts -nav_order: 103 +nav_order: 104 parent: Modules --- diff --git a/docs/modules/void.ts.md b/docs/modules/void.ts.md index 9e6bcb394..55efbbb3c 100644 --- a/docs/modules/void.ts.md +++ b/docs/modules/void.ts.md @@ -1,6 +1,6 @@ --- title: void.ts -nav_order: 117 +nav_order: 118 parent: Modules --- diff --git a/src/IOEither.ts b/src/IOEither.ts index 449ee0644..88dd2f760 100644 --- a/src/IOEither.ts +++ b/src/IOEither.ts @@ -266,7 +266,7 @@ export const orElseFirstW: ( /** * @category combinators - * @since 2.11.8 + * @since 2.12.0 */ export const orElseFirstIOK: (onLeft: (e: E) => IO) => (ma: IOEither) => IOEither = (onLeft) => orElseFirst(fromIOK(onLeft)) diff --git a/src/TaskEither.ts b/src/TaskEither.ts index 114cadbfe..9e15d3430 100644 --- a/src/TaskEither.ts +++ b/src/TaskEither.ts @@ -358,7 +358,7 @@ export const orElseFirstW: ( /** * @category combinators - * @since 2.11.8 + * @since 2.12.0 */ export const orElseFirstIOK: (onLeft: (e: E) => IO) => (ma: TaskEither) => TaskEither = ( onLeft @@ -366,7 +366,7 @@ export const orElseFirstIOK: (onLeft: (e: E) => IO) => (ma: TaskEith /** * @category combinators - * @since 2.11.8 + * @since 2.12.0 */ export const orElseFirstTaskK: (onLeft: (e: E) => Task) => (ma: TaskEither) => TaskEither = ( onLeft