docs: flatMapReaderTask, flatMapTaskEither, flatMapIO

gcanti · May 21, 2023 · c95947c · c95947c
1 parent c72b082
commit c95947c
Show file tree

Hide file tree

Showing 9 changed files with 406 additions and 189 deletions.
diff --git a/docs/modules/IOEither.ts.md b/docs/modules/IOEither.ts.md
@@ -87,6 +87,7 @@ Added in v2.0.0
   - [chainFirstEitherKW](#chainfirsteitherkw)
   - [chainFirstIOK](#chainfirstiok)
   - [chainFirstW](#chainfirstw)
+  - [chainIOK](#chainiok)
   - [chainOptionK](#chainoptionk)
   - [chainOptionKW](#chainoptionkw)
   - [chainW](#chainw)
@@ -115,9 +116,9 @@ Added in v2.0.0
   - [matchEW](#matchew)
   - [matchW](#matchw)
 - [sequencing](#sequencing)
-  - [chainIOK](#chainiok)
   - [flatMap](#flatmap)
   - [flatMapEither](#flatmapeither)
+  - [flatMapIO](#flatmapio)
   - [flatMapNullable](#flatmapnullable)
   - [flatMapOption](#flatmapoption)
   - [flatten](#flatten)
@@ -978,6 +979,18 @@ export declare const chainFirstW: <E2, A, B>(
 
 Added in v2.8.0
 
+## chainIOK
+
+Alias of `flatMapIO`.
+
+**Signature**
+
+```ts
+export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: IOEither<E, A>) => IOEither<E, B>
+```
+
+Added in v2.10.0
+
 ## chainOptionK
 
 Use `flatMapOption`.
@@ -1295,16 +1308,6 @@ Added in v2.10.0
 
 # sequencing
 
-## chainIOK
-
-**Signature**
-
-```ts
-export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: IOEither<E, A>) => IOEither<E, B>
-```
-
-Added in v2.10.0
-
 ## flatMap
 
 **Signature**
@@ -1331,6 +1334,19 @@ export declare const flatMapEither: {
 
 Added in v2.15.0
 
+## flatMapIO
+
+**Signature**
+
+```ts
+export declare const flatMapIO: {
+  <A, B>(f: (a: A) => I.IO<B>): <E>(self: IOEither<E, A>) => IOEither<E, B>
+  <E, A, B>(self: IOEither<E, A>, f: (a: A) => I.IO<B>): IOEither<E, B>
+}
+```
+
+Added in v2.16.0
+
 ## flatMapNullable
 
 **Signature**

diff --git a/docs/modules/IOOption.ts.md b/docs/modules/IOOption.ts.md
@@ -72,6 +72,7 @@ Added in v2.12.0
   - [chainFirst](#chainfirst)
   - [chainFirstEitherK](#chainfirsteitherk)
   - [chainFirstIOK](#chainfirstiok)
+  - [chainIOK](#chainiok)
 - [lifting](#lifting)
   - [fromEitherK](#fromeitherk)
   - [fromIOK](#fromiok)
@@ -93,10 +94,10 @@ Added in v2.12.0
   - [matchW](#matchw)
 - [sequencing](#sequencing)
   - [chainEitherK](#chaineitherk)
-  - [chainIOK](#chainiok)
   - [chainNullableK](#chainnullablek)
   - [chainOptionK](#chainoptionk)
   - [flatMap](#flatmap)
+  - [flatMapIO](#flatmapio)
   - [flatten](#flatten)
 - [traversing](#traversing)
   - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex)
@@ -698,6 +699,18 @@ export declare const chainFirstIOK: <A, B>(f: (a: A) => I.IO<B>) => (first: IOOp
 
 Added in v2.12.0
 
+## chainIOK
+
+Alias of `flatMapIO`.
+
+**Signature**
+
+```ts
+export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => (first: IOOption<A>) => IOOption<B>
+```
+
+Added in v2.12.0
+
 # lifting
 
 ## fromEitherK
@@ -903,16 +916,6 @@ export declare const chainEitherK: <E, A, B>(f: (a: A) => Either<E, B>) => (ma:
 
 Added in v2.12.0
 
-## chainIOK
-
-**Signature**
-
-```ts
-export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => (first: IOOption<A>) => IOOption<B>
-```
-
-Added in v2.12.0
-
 ## chainNullableK
 
 **Signature**
@@ -948,6 +951,19 @@ export declare const flatMap: {
 
 Added in v2.14.0
 
+## flatMapIO
+
+**Signature**
+
+```ts
+export declare const flatMapIO: {
+  <A, B>(f: (a: A) => I.IO<B>): (ma: IOOption<A>) => IOOption<B>
+  <A, B>(ma: IOOption<A>, f: (a: A) => I.IO<B>): IOOption<B>
+}
+```
+
+Added in v2.16.0
+
 ## flatten
 
 **Signature**

diff --git a/docs/modules/ReaderIO.ts.md b/docs/modules/ReaderIO.ts.md
@@ -49,6 +49,7 @@ Added in v2.13.0
   - [chainFirstReaderK](#chainfirstreaderk)
   - [chainFirstReaderKW](#chainfirstreaderkw)
   - [chainFirstW](#chainfirstw)
+  - [chainIOK](#chainiok)
   - [chainW](#chainw)
 - [lifting](#lifting)
   - [fromIOK](#fromiok)
@@ -61,10 +62,10 @@ Added in v2.13.0
 - [model](#model)
   - [ReaderIO (interface)](#readerio-interface)
 - [sequencing](#sequencing)
-  - [chainIOK](#chainiok)
   - [chainReaderK](#chainreaderk)
   - [chainReaderKW](#chainreaderkw)
   - [flatMap](#flatmap)
+  - [flatMapIO](#flatmapio)
   - [flatten](#flatten)
   - [flattenW](#flattenw)
 - [traversing](#traversing)
@@ -494,6 +495,18 @@ export declare const chainFirstW: <A, R2, B>(
 
 Added in v2.13.0
 
+## chainIOK
+
+Alias of `flatMapIO`.
+
+**Signature**
+
+```ts
+export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: ReaderIO<E, A>) => ReaderIO<E, B>
+```
+
+Added in v2.13.0
+
 ## chainW
 
 Alias of `flatMap`.
@@ -602,16 +615,6 @@ Added in v2.13.0
 
 # sequencing
 
-## chainIOK
-
-**Signature**
-
-```ts
-export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: ReaderIO<E, A>) => ReaderIO<E, B>
-```
-
-Added in v2.13.0
-
 ## chainReaderK
 
 **Signature**
@@ -651,6 +654,19 @@ export declare const flatMap: {
 
 Added in v2.14.0
 
+## flatMapIO
+
+**Signature**
+
+```ts
+export declare const flatMapIO: {
+  <A, B>(f: (a: A) => I.IO<B>): <R>(ma: ReaderIO<R, A>) => ReaderIO<R, B>
+  <R, A, B>(ma: ReaderIO<R, A>, f: (a: A) => I.IO<B>): ReaderIO<R, B>
+}
+```
+
+Added in v2.16.0
+
 ## flatten
 
 **Signature**

diff --git a/docs/modules/ReaderTask.ts.md b/docs/modules/ReaderTask.ts.md
@@ -61,6 +61,7 @@ Added in v2.3.0
   - [chainFirstReaderKW](#chainfirstreaderkw)
   - [chainFirstTaskK](#chainfirsttaskk)
   - [chainFirstW](#chainfirstw)
+  - [chainIOK](#chainiok)
   - [chainW](#chainw)
 - [lifting](#lifting)
   - [fromIOK](#fromiok)
@@ -75,13 +76,13 @@ Added in v2.3.0
 - [model](#model)
   - [ReaderTask (interface)](#readertask-interface)
 - [sequencing](#sequencing)
-  - [chainIOK](#chainiok)
   - [chainReaderIOK](#chainreaderiok)
   - [chainReaderIOKW](#chainreaderiokw)
   - [chainReaderK](#chainreaderk)
   - [chainReaderKW](#chainreaderkw)
   - [chainTaskK](#chaintaskk)
   - [flatMap](#flatmap)
+  - [flatMapIO](#flatmapio)
   - [flatten](#flatten)
   - [flattenW](#flattenw)
 - [traversing](#traversing)
@@ -700,6 +701,18 @@ export declare const chainFirstW: <R2, A, B>(
 
 Added in v2.11.0
 
+## chainIOK
+
+Alias of `flatMapIO`.
+
+**Signature**
+
+```ts
+export declare const chainIOK: <A, B>(f: (a: A) => IO<B>) => <R>(first: ReaderTask<R, A>) => ReaderTask<R, B>
+```
+
+Added in v2.4.0
+
 ## chainW
 
 Alias of `flatMap`.
@@ -832,16 +845,6 @@ Added in v2.3.0
 
 # sequencing
 
-## chainIOK
-
-**Signature**
-
-```ts
-export declare const chainIOK: <A, B>(f: (a: A) => IO<B>) => <R>(first: ReaderTask<R, A>) => ReaderTask<R, B>
-```
-
-Added in v2.4.0
-
 ## chainReaderIOK
 
 **Signature**
@@ -917,6 +920,19 @@ export declare const flatMap: {
 
 Added in v2.14.0
 
+## flatMapIO
+
+**Signature**
+
+```ts
+export declare const flatMapIO: {
+  <A, B>(f: (a: A) => IO<B>): <R>(ma: ReaderTask<R, A>) => ReaderTask<R, B>
+  <R, A, B>(ma: ReaderTask<R, A>, f: (a: A) => IO<B>): ReaderTask<R, B>
+}
+```
+
+Added in v2.16.0
+
 ## flatten
 
 **Signature**