docs: flatMapReader, flatMapTask

gcanti · May 22, 2023 · 9ba16df · 9ba16df
1 parent 8be1186
commit 9ba16df
Show file tree

Hide file tree

Showing 7 changed files with 365 additions and 188 deletions.
diff --git a/docs/modules/ReaderEither.ts.md b/docs/modules/ReaderEither.ts.md
@@ -82,6 +82,8 @@ Added in v2.0.0
   - [chainFirstW](#chainfirstw)
   - [chainOptionK](#chainoptionk)
   - [chainOptionKW](#chainoptionkw)
+  - [chainReaderK](#chainreaderk)
+  - [chainReaderKW](#chainreaderkw)
   - [chainW](#chainw)
   - [fromOptionK](#fromoptionk)
   - [mapLeft](#mapleft)
@@ -108,12 +110,11 @@ Added in v2.0.0
   - [matchEW](#matchew)
   - [matchW](#matchw)
 - [sequencing](#sequencing)
-  - [chainReaderK](#chainreaderk)
-  - [chainReaderKW](#chainreaderkw)
   - [flatMap](#flatmap)
   - [flatMapEither](#flatmapeither)
   - [flatMapNullable](#flatmapnullable)
   - [flatMapOption](#flatmapoption)
+  - [flatMapReader](#flatmapreader)
   - [flatten](#flatten)
   - [flattenW](#flattenw)
 - [traversing](#traversing)
@@ -1027,6 +1028,38 @@ export declare const chainOptionKW: <E2>(
 
 Added in v2.13.2
 
+## chainReaderK
+
+Alias of `flatMapReader`.
+
+**Signature**
+
+```ts
+export declare const chainReaderK: <A, R, B>(
+  f: (a: A) => R.Reader<R, B>
+) => <E>(ma: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
+```
+
+Added in v2.11.0
+
+## chainReaderKW
+
+Alias of `flatMapReader`.
+
+Less strict version of [`chainReaderK`](#chainreaderk).
+
+The `W` suffix (short for **W**idening) means that the environment types will be merged.
+
+**Signature**
+
+```ts
+export declare const chainReaderKW: <A, R2, B>(
+  f: (a: A) => R.Reader<R2, B>
+) => <R1, E>(ma: ReaderEither<R1, E, A>) => ReaderEither<R1 & R2, E, B>
+```
+
+Added in v2.11.0
+
 ## chainW
 
 Alias of `flatMap`.
@@ -1321,34 +1354,6 @@ Added in v2.10.0
 
 # sequencing
 
-## chainReaderK
-
-**Signature**
-
-```ts
-export declare const chainReaderK: <A, R, B>(
-  f: (a: A) => R.Reader<R, B>
-) => <E>(ma: ReaderEither<R, E, A>) => ReaderEither<R, E, B>
-```
-
-Added in v2.11.0
-
-## chainReaderKW
-
-Less strict version of [`chainReaderK`](#chainreaderk).
-
-The `W` suffix (short for **W**idening) means that the environment types will be merged.
-
-**Signature**
-
-```ts
-export declare const chainReaderKW: <A, R2, B>(
-  f: (a: A) => R.Reader<R2, B>
-) => <R1, E>(ma: ReaderEither<R1, E, A>) => ReaderEither<R1 & R2, E, B>
-```
-
-Added in v2.11.0
-
 ## flatMap
 
 **Signature**
@@ -1419,6 +1424,19 @@ export declare const flatMapOption: {
 
 Added in v2.15.0
 
+## flatMapReader
+
+**Signature**
+
+```ts
+export declare const flatMapReader: {
+  <A, R2, B>(f: (a: A) => R.Reader<R2, B>): <R1, E>(self: ReaderEither<R1, E, A>) => ReaderEither<R1 & R2, E, B>
+  <R1, R2, E, A, B>(self: ReaderEither<R1, E, A>, f: (a: A) => R.Reader<R2, B>): ReaderEither<R1 & R2, E, B>
+}
+```
+
+Added in v2.15.0
+
 ## flatten
 
 **Signature**

diff --git a/docs/modules/ReaderIO.ts.md b/docs/modules/ReaderIO.ts.md
@@ -50,6 +50,8 @@ Added in v2.13.0
   - [chainFirstReaderKW](#chainfirstreaderkw)
   - [chainFirstW](#chainfirstw)
   - [chainIOK](#chainiok)
+  - [chainReaderK](#chainreaderk)
+  - [chainReaderKW](#chainreaderkw)
   - [chainW](#chainw)
 - [lifting](#lifting)
   - [fromIOK](#fromiok)
@@ -62,10 +64,9 @@ Added in v2.13.0
 - [model](#model)
   - [ReaderIO (interface)](#readerio-interface)
 - [sequencing](#sequencing)
-  - [chainReaderK](#chainreaderk)
-  - [chainReaderKW](#chainreaderkw)
   - [flatMap](#flatmap)
   - [flatMapIO](#flatmapio)
+  - [flatMapReader](#flatmapreader)
   - [flatten](#flatten)
   - [flattenW](#flattenw)
 - [traversing](#traversing)
@@ -507,6 +508,36 @@ export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: Reader
 
 Added in v2.13.0
 
+## chainReaderK
+
+Alias of `flatMapReader`.
+
+**Signature**
+
+```ts
+export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderIO<R, A>) => ReaderIO<R, B>
+```
+
+Added in v2.13.0
+
+## chainReaderKW
+
+Alias of `flatMapReader`.
+
+Less strict version of [`chainReaderK`](#chainreaderk).
+
+The `W` suffix (short for **W**idening) means that the environment types will be merged.
+
+**Signature**
+
+```ts
+export declare const chainReaderKW: <A, R1, B>(
+  f: (a: A) => R.Reader<R1, B>
+) => <R2>(ma: ReaderIO<R2, A>) => ReaderIO<R1 & R2, B>
+```
+
+Added in v2.13.0
+
 ## chainW
 
 Alias of `flatMap`.
@@ -615,32 +646,6 @@ Added in v2.13.0
 
 # sequencing
 
-## chainReaderK
-
-**Signature**
-
-```ts
-export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderIO<R, A>) => ReaderIO<R, B>
-```
-
-Added in v2.13.0
-
-## chainReaderKW
-
-Less strict version of [`chainReaderK`](#chainreaderk).
-
-The `W` suffix (short for **W**idening) means that the environment types will be merged.
-
-**Signature**
-
-```ts
-export declare const chainReaderKW: <A, R1, B>(
-  f: (a: A) => R.Reader<R1, B>
-) => <R2>(ma: ReaderIO<R2, A>) => ReaderIO<R1 & R2, B>
-```
-
-Added in v2.13.0
-
 ## flatMap
 
 **Signature**
@@ -667,6 +672,19 @@ export declare const flatMapIO: {
 
 Added in v2.16.0
 
+## flatMapReader
+
+**Signature**
+
+```ts
+export declare const flatMapReader: {
+  <A, R2, B>(f: (a: A) => R.Reader<R2, B>): <R1>(ma: ReaderIO<R1, A>) => ReaderIO<R1 & R2, B>
+  <R1, A, R2, B>(ma: ReaderIO<R1, A>, f: (a: A) => R.Reader<R2, B>): ReaderIO<R1 & R2, B>
+}
+```
+
+Added in v2.16.0
+
 ## flatten
 
 **Signature**

diff --git a/docs/modules/ReaderTask.ts.md b/docs/modules/ReaderTask.ts.md
@@ -62,6 +62,9 @@ Added in v2.3.0
   - [chainFirstTaskK](#chainfirsttaskk)
   - [chainFirstW](#chainfirstw)
   - [chainIOK](#chainiok)
+  - [chainReaderK](#chainreaderk)
+  - [chainReaderKW](#chainreaderkw)
+  - [chainTaskK](#chaintaskk)
   - [chainW](#chainw)
 - [lifting](#lifting)
   - [fromIOK](#fromiok)
@@ -78,11 +81,10 @@ Added in v2.3.0
 - [sequencing](#sequencing)
   - [chainReaderIOK](#chainreaderiok)
   - [chainReaderIOKW](#chainreaderiokw)
-  - [chainReaderK](#chainreaderk)
-  - [chainReaderKW](#chainreaderkw)
-  - [chainTaskK](#chaintaskk)
   - [flatMap](#flatmap)
   - [flatMapIO](#flatmapio)
+  - [flatMapReader](#flatmapreader)
+  - [flatMapTask](#flatmaptask)
   - [flatten](#flatten)
   - [flattenW](#flattenw)
 - [traversing](#traversing)
@@ -713,6 +715,48 @@ export declare const chainIOK: <A, B>(f: (a: A) => IO<B>) => <R>(first: ReaderTa
 
 Added in v2.4.0
 
+## chainReaderK
+
+Alias of `flatMapReader`.
+
+**Signature**
+
+```ts
+export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderTask<R, A>) => ReaderTask<R, B>
+```
+
+Added in v2.11.0
+
+## chainReaderKW
+
+Alias of `flatMapReader`.
+
+Less strict version of [`chainReaderK`](#chainreaderk).
+
+The `W` suffix (short for **W**idening) means that the environment types will be merged.
+
+**Signature**
+
+```ts
+export declare const chainReaderKW: <A, R1, B>(
+  f: (a: A) => R.Reader<R1, B>
+) => <R2>(ma: ReaderTask<R2, A>) => ReaderTask<R1 & R2, B>
+```
+
+Added in v2.11.0
+
+## chainTaskK
+
+Alias of `flatMapTask`.
+
+**Signature**
+
+```ts
+export declare const chainTaskK: <A, B>(f: (a: A) => T.Task<B>) => <R>(first: ReaderTask<R, A>) => ReaderTask<R, B>
+```
+
+Added in v2.4.0
+
 ## chainW
 
 Alias of `flatMap`.
@@ -871,63 +915,53 @@ export declare const chainReaderIOKW: <A, R2, B>(
 
 Added in v2.13.0
 
-## chainReaderK
-
-**Signature**
-
-```ts
-export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderTask<R, A>) => ReaderTask<R, B>
-```
-
-Added in v2.11.0
-
-## chainReaderKW
-
-Less strict version of [`chainReaderK`](#chainreaderk).
-
-The `W` suffix (short for **W**idening) means that the environment types will be merged.
+## flatMap
 
 **Signature**
 
 ```ts
-export declare const chainReaderKW: <A, R1, B>(
-  f: (a: A) => R.Reader<R1, B>
-) => <R2>(ma: ReaderTask<R2, A>) => ReaderTask<R1 & R2, B>
+export declare const flatMap: {
+  <A, R2, B>(f: (a: A) => ReaderTask<R2, B>): <R1>(ma: ReaderTask<R1, A>) => ReaderTask<R1 & R2, B>
+  <R1, A, R2, B>(ma: ReaderTask<R1, A>, f: (a: A) => ReaderTask<R2, B>): ReaderTask<R1 & R2, B>
+}
 ```
 
-Added in v2.11.0
+Added in v2.14.0
 
-## chainTaskK
+## flatMapIO
 
 **Signature**
 
 ```ts
-export declare const chainTaskK: <A, B>(f: (a: A) => T.Task<B>) => <R>(first: ReaderTask<R, A>) => ReaderTask<R, B>
+export declare const flatMapIO: {
+  <A, B>(f: (a: A) => IO<B>): <R>(self: ReaderTask<R, A>) => ReaderTask<R, B>
+  <R, A, B>(self: ReaderTask<R, A>, f: (a: A) => IO<B>): ReaderTask<R, B>
+}
 ```
 
-Added in v2.4.0
+Added in v2.16.0
 
-## flatMap
+## flatMapReader
 
 **Signature**
 
 ```ts
-export declare const flatMap: {
-  <A, R2, B>(f: (a: A) => ReaderTask<R2, B>): <R1>(ma: ReaderTask<R1, A>) => ReaderTask<R1 & R2, B>
-  <R1, A, R2, B>(ma: ReaderTask<R1, A>, f: (a: A) => ReaderTask<R2, B>): ReaderTask<R1 & R2, B>
+export declare const flatMapReader: {
+  <R2, A, B>(f: (a: A) => R.Reader<R2, B>): <R1>(self: ReaderTask<R1, A>) => ReaderTask<R1 & R2, B>
+  <R1, R2, A, B>(self: ReaderTask<R1, A>, f: (a: A) => R.Reader<R2, B>): ReaderTask<R1 & R2, B>
 }
 ```
 
-Added in v2.14.0
+Added in v2.16.0
 
-## flatMapIO
+## flatMapTask
 
 **Signature**
 
 ```ts
-export declare const flatMapIO: {
-  <A, B>(f: (a: A) => IO<B>): <R>(self: ReaderTask<R, A>) => ReaderTask<R, B>
-  <R, A, B>(self: ReaderTask<R, A>, f: (a: A) => IO<B>): ReaderTask<R, B>
+export declare const flatMapTask: {
+  <A, B>(f: (a: A) => T.Task<B>): <R>(self: ReaderTask<R, A>) => ReaderTask<R, B>
+  <R, A, B>(self: ReaderTask<R, A>, f: (a: A) => T.Task<B>): ReaderTask<R, B>
 }
 ```