diff --git a/docs/modules/ReaderTaskEither.ts.md b/docs/modules/ReaderTaskEither.ts.md index 6a448f2a6..7b30da0e9 100644 --- a/docs/modules/ReaderTaskEither.ts.md +++ b/docs/modules/ReaderTaskEither.ts.md @@ -117,10 +117,14 @@ Added in v2.0.0 - [chainFirstTaskEitherKW](#chainfirsttaskeitherkw) - [chainFirstTaskK](#chainfirsttaskk) - [chainFirstW](#chainfirstw) + - [chainIOEitherK](#chainioeitherk) + - [chainIOEitherKW](#chainioeitherkw) - [chainIOK](#chainiok) - [chainNullableK](#chainnullablek) - [chainOptionK](#chainoptionk) - [chainOptionKW](#chainoptionkw) + - [chainReaderEitherK](#chainreadereitherk) + - [chainReaderEitherKW](#chainreadereitherkw) - [chainReaderIOK](#chainreaderiok) - [chainReaderIOKW](#chainreaderiokw) - [chainReaderK](#chainreaderk) @@ -164,16 +168,14 @@ Added in v2.0.0 - [matchEW](#matchew) - [matchW](#matchw) - [sequencing](#sequencing) - - [chainIOEitherK](#chainioeitherk) - - [chainIOEitherKW](#chainioeitherkw) - - [chainReaderEitherK](#chainreadereitherk) - - [chainReaderEitherKW](#chainreadereitherkw) - [flatMap](#flatmap) - [flatMapEither](#flatmapeither) - [flatMapIO](#flatmapio) + - [flatMapIOEither](#flatmapioeither) - [flatMapNullable](#flatmapnullable) - [flatMapOption](#flatmapoption) - [flatMapReader](#flatmapreader) + - [flatMapReaderEither](#flatmapreadereither) - [flatMapReaderIO](#flatmapreaderio) - [flatMapReaderTask](#flatmapreadertask) - [flatMapTask](#flatmaptask) @@ -1619,6 +1621,38 @@ export declare const chainFirstW: ( Added in v2.8.0 +## chainIOEitherK + +Alias of `flatMapIOEither`. + +**Signature** + +```ts +export declare const chainIOEitherK: ( + f: (a: A) => IOEither +) => (ma: ReaderTaskEither) => ReaderTaskEither +``` + +Added in v2.4.0 + +## chainIOEitherKW + +Alias of `flatMapIOEither`. + +Less strict version of [`chainIOEitherK`](#chainioeitherk). + +The `W` suffix (short for **W**idening) means that the environment types and the error types will be merged. + +**Signature** + +```ts +export declare const chainIOEitherKW: ( + f: (a: A) => IOEither +) => (ma: ReaderTaskEither) => ReaderTaskEither +``` + +Added in v2.6.1 + ## chainIOK Alias of `flatMapIO`. @@ -1677,6 +1711,38 @@ export declare const chainOptionKW: ( Added in v2.13.2 +## chainReaderEitherK + +Alias of `flatMapReaderEither`. + +**Signature** + +```ts +export declare const chainReaderEitherK: ( + f: (a: A) => ReaderEither +) => (ma: ReaderTaskEither) => ReaderTaskEither +``` + +Added in v2.11.0 + +## chainReaderEitherKW + +Alias of `flatMapReaderEither`. + +Less strict version of [`chainReaderEitherK`](#chainreadereitherk). + +The `W` suffix (short for **W**idening) means that the environment types and the error types will be merged. + +**Signature** + +```ts +export declare const chainReaderEitherKW: ( + f: (a: A) => ReaderEither +) => (ma: ReaderTaskEither) => ReaderTaskEither +``` + +Added in v2.11.0 + ## chainReaderIOK Alias of `flatMapReaderIO`. @@ -2219,62 +2285,6 @@ Added in v2.10.0 # sequencing -## chainIOEitherK - -**Signature** - -```ts -export declare const chainIOEitherK: ( - f: (a: A) => IOEither -) => (ma: ReaderTaskEither) => ReaderTaskEither -``` - -Added in v2.4.0 - -## chainIOEitherKW - -Less strict version of [`chainIOEitherK`](#chainioeitherk). - -The `W` suffix (short for **W**idening) means that the environment types and the error types will be merged. - -**Signature** - -```ts -export declare const chainIOEitherKW: ( - f: (a: A) => IOEither -) => (ma: ReaderTaskEither) => ReaderTaskEither -``` - -Added in v2.6.1 - -## chainReaderEitherK - -**Signature** - -```ts -export declare const chainReaderEitherK: ( - f: (a: A) => ReaderEither -) => (ma: ReaderTaskEither) => ReaderTaskEither -``` - -Added in v2.11.0 - -## chainReaderEitherKW - -Less strict version of [`chainReaderEitherK`](#chainreadereitherk). - -The `W` suffix (short for **W**idening) means that the environment types and the error types will be merged. - -**Signature** - -```ts -export declare const chainReaderEitherKW: ( - f: (a: A) => ReaderEither -) => (ma: ReaderTaskEither) => ReaderTaskEither -``` - -Added in v2.11.0 - ## flatMap **Signature** @@ -2320,6 +2330,19 @@ export declare const flatMapIO: { Added in v2.16.0 +## flatMapIOEither + +**Signature** + +```ts +export declare const flatMapIOEither: { + (f: (a: A) => IOEither): (self: ReaderTaskEither) => ReaderTaskEither + (self: ReaderTaskEither, f: (a: A) => IOEither): ReaderTaskEither +} +``` + +Added in v2.16.0 + ## flatMapNullable **Signature** @@ -2371,6 +2394,25 @@ export declare const flatMapReader: { Added in v2.16.0 +## flatMapReaderEither + +**Signature** + +```ts +export declare const flatMapReaderEither: { + (f: (a: A) => ReaderEither): ( + self: ReaderTaskEither + ) => ReaderTaskEither + (self: ReaderTaskEither, f: (a: A) => ReaderEither): ReaderTaskEither< + R1 & R2, + E1 | E2, + B + > +} +``` + +Added in v2.16.0 + ## flatMapReaderIO **Signature** diff --git a/docs/modules/StateReaderTaskEither.ts.md b/docs/modules/StateReaderTaskEither.ts.md index cd4995e7a..20b198f5c 100644 --- a/docs/modules/StateReaderTaskEither.ts.md +++ b/docs/modules/StateReaderTaskEither.ts.md @@ -77,6 +77,7 @@ Added in v2.0.0 - [Pointed](#pointed) - [legacy](#legacy) - [chain](#chain) + - [chainEitherK](#chaineitherk) - [chainFirst](#chainfirst) - [chainFirstEitherK](#chainfirsteitherk) - [chainFirstEitherKW](#chainfirsteitherkw) @@ -85,11 +86,17 @@ Added in v2.0.0 - [chainFirstReaderKW](#chainfirstreaderkw) - [chainFirstTaskK](#chainfirsttaskk) - [chainFirstW](#chainfirstw) + - [chainIOEitherK](#chainioeitherk) + - [chainIOEitherKW](#chainioeitherkw) - [chainIOK](#chainiok) + - [chainOptionK](#chainoptionk) + - [chainOptionKW](#chainoptionkw) - [chainReaderK](#chainreaderk) - [chainReaderKW](#chainreaderkw) + - [chainStateK](#chainstatek) - [chainTaskEitherK](#chaintaskeitherk) - [chainTaskEitherKW](#chaintaskeitherkw) + - [chainTaskK](#chaintaskk) - [chainW](#chainw) - [lifting](#lifting) - [fromEitherK](#fromeitherk) @@ -111,19 +118,17 @@ Added in v2.0.0 - [model](#model) - [StateReaderTaskEither (interface)](#statereadertaskeither-interface) - [sequencing](#sequencing) - - [chainEitherK](#chaineitherk) - [chainEitherKW](#chaineitherkw) - - [chainIOEitherK](#chainioeitherk) - - [chainIOEitherKW](#chainioeitherkw) - - [chainOptionK](#chainoptionk) - - [chainOptionKW](#chainoptionkw) - [chainReaderTaskEitherK](#chainreadertaskeitherk) - [chainReaderTaskEitherKW](#chainreadertaskeitherkw) - - [chainStateK](#chainstatek) - - [chainTaskK](#chaintaskk) - [flatMap](#flatmap) + - [flatMapEither](#flatmapeither) - [flatMapIO](#flatmapio) + - [flatMapIOEither](#flatmapioeither) + - [flatMapOption](#flatmapoption) - [flatMapReader](#flatmapreader) + - [flatMapReaderTaskEither](#flatmapreadertaskeither) + - [flatMapState](#flatmapstate) - [flatMapTask](#flatmaptask) - [flatMapTaskEither](#flatmaptaskeither) - [flatten](#flatten) @@ -873,6 +878,20 @@ export declare const chain: ( Added in v2.0.0 +## chainEitherK + +Alias of `flatMapEither`. + +**Signature** + +```ts +export declare const chainEitherK: ( + f: (a: A) => E.Either +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.4.0 + ## chainFirst Alias of `tap`. @@ -993,6 +1012,36 @@ export declare const chainFirstW: ( Added in v2.8.0 +## chainIOEitherK + +Alias of `flatMapIOEither`. + +**Signature** + +```ts +export declare const chainIOEitherK: ( + f: (a: A) => IOEither +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.4.0 + +## chainIOEitherKW + +Alias of `flatMapIOEither`. + +Less strict version of [`chainIOEitherK`](#chainioeitherk). + +**Signature** + +```ts +export declare const chainIOEitherKW: ( + f: (a: A) => IOEither +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.6.1 + ## chainIOK Alias of `flatMapIO`. @@ -1007,6 +1056,42 @@ export declare const chainIOK: ( Added in v2.10.0 +## chainOptionK + +Use `flatMapOption`. + +**Signature** + +```ts +export declare const chainOptionK: ( + onNone: LazyArg +) => ( + f: (a: A) => Option +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.10.0 + +## chainOptionKW + +Use `flatMapOption`. + +Less strict version of [`chainOptionK`](#chainoptionk). + +The `W` suffix (short for **W**idening) means that the error types will be merged. + +**Signature** + +```ts +export declare const chainOptionKW: ( + onNone: LazyArg +) => ( + f: (a: A) => Option +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.13.2 + ## chainReaderK Alias of `flatMapReader`. @@ -1039,6 +1124,20 @@ export declare const chainReaderKW: ( Added in v2.11.0 +## chainStateK + +Alias of `flatMapState`. + +**Signature** + +```ts +export declare const chainStateK: ( + f: (a: A) => State +) => (ma: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.11.0 + ## chainTaskEitherK Alias of `flatMapTaskEither`. @@ -1069,6 +1168,20 @@ export declare const chainTaskEitherKW: ( Added in v2.6.1 +## chainTaskK + +Alias of `flatMapTask`. + +**Signature** + +```ts +export declare const chainTaskK: ( + f: (a: A) => Task +) => (first: StateReaderTaskEither) => StateReaderTaskEither +``` + +Added in v2.10.0 + ## chainW Alias of `flatMap`. @@ -1302,20 +1415,10 @@ Added in v2.0.0 # sequencing -## chainEitherK - -**Signature** - -```ts -export declare const chainEitherK: ( - f: (a: A) => E.Either -) => (ma: StateReaderTaskEither) => StateReaderTaskEither -``` - -Added in v2.4.0 - ## chainEitherKW +Alias of `flatMapEither`. + Less strict version of [`chainEitherK`](#chaineitherk). The `W` suffix (short for **W**idening) means that the error types will be merged. @@ -1332,162 +1435,170 @@ export declare const chainEitherKW: ( Added in v2.6.1 -## chainIOEitherK +## chainReaderTaskEitherK **Signature** ```ts -export declare const chainIOEitherK: ( - f: (a: A) => IOEither -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const chainReaderTaskEitherK: ( + f: (a: A) => RTE.ReaderTaskEither +) => (ma: StateReaderTaskEither) => StateReaderTaskEither ``` Added in v2.4.0 -## chainIOEitherKW +## chainReaderTaskEitherKW -Less strict version of [`chainIOEitherK`](#chainioeitherk). +Less strict version of [`chainReaderTaskEitherK`](#chainreadertaskeitherk). **Signature** ```ts -export declare const chainIOEitherKW: ( - f: (a: A) => IOEither -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const chainReaderTaskEitherKW: ( + f: (a: A) => RTE.ReaderTaskEither +) => (ma: StateReaderTaskEither) => StateReaderTaskEither ``` Added in v2.6.1 -## chainOptionK +## flatMap **Signature** ```ts -export declare const chainOptionK: ( - onNone: LazyArg -) => ( - f: (a: A) => Option -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMap: { + (f: (a: A) => StateReaderTaskEither): ( + ma: StateReaderTaskEither + ) => StateReaderTaskEither + ( + ma: StateReaderTaskEither, + f: (a: A) => StateReaderTaskEither + ): StateReaderTaskEither +} ``` -Added in v2.10.0 - -## chainOptionKW - -Less strict version of [`chainOptionK`](#chainoptionk). +Added in v2.14.0 -The `W` suffix (short for **W**idening) means that the error types will be merged. +## flatMapEither **Signature** ```ts -export declare const chainOptionKW: ( - onNone: LazyArg -) => ( - f: (a: A) => Option -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMapEither: { + (f: (a: A) => E.Either): ( + self: StateReaderTaskEither + ) => StateReaderTaskEither + (self: StateReaderTaskEither, f: (a: A) => E.Either): StateReaderTaskEither< + S, + R, + E1 | E2, + B + > +} ``` -Added in v2.13.2 +Added in v2.16.0 -## chainReaderTaskEitherK +## flatMapIO **Signature** ```ts -export declare const chainReaderTaskEitherK: ( - f: (a: A) => RTE.ReaderTaskEither -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMapIO: { + (f: (a: A) => IO): (self: StateReaderTaskEither) => StateReaderTaskEither + (self: StateReaderTaskEither, f: (a: A) => IO): StateReaderTaskEither +} ``` -Added in v2.4.0 +Added in v2.16.0 -## chainReaderTaskEitherKW - -Less strict version of [`chainReaderTaskEitherK`](#chainreadertaskeitherk). +## flatMapIOEither **Signature** ```ts -export declare const chainReaderTaskEitherKW: ( - f: (a: A) => RTE.ReaderTaskEither -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMapIOEither: { + (f: (a: A) => IOEither): ( + self: StateReaderTaskEither + ) => StateReaderTaskEither + (self: StateReaderTaskEither, f: (a: A) => IOEither): StateReaderTaskEither< + S, + R, + E1 | E2, + B + > +} ``` -Added in v2.6.1 +Added in v2.16.0 -## chainStateK +## flatMapOption **Signature** ```ts -export declare const chainStateK: ( - f: (a: A) => State -) => (ma: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMapOption: { + (f: (a: A) => Option, onNone: (a: A) => E2): ( + self: StateReaderTaskEither + ) => StateReaderTaskEither + ( + self: StateReaderTaskEither, + f: (a: A) => Option, + onNone: (a: A) => E2 + ): StateReaderTaskEither +} ``` -Added in v2.11.0 - -## chainTaskK +Added in v2.16.0 -Alias of `flatMapTask`. +## flatMapReader **Signature** ```ts -export declare const chainTaskK: ( - f: (a: A) => Task -) => (first: StateReaderTaskEither) => StateReaderTaskEither +export declare const flatMapReader: { + (f: (a: A) => R.Reader): ( + self: StateReaderTaskEither + ) => StateReaderTaskEither + (self: StateReaderTaskEither, f: (a: A) => R.Reader): StateReaderTaskEither< + S, + R1 & R2, + E, + B + > +} ``` -Added in v2.10.0 +Added in v2.16.0 -## flatMap +## flatMapReaderTaskEither **Signature** ```ts -export declare const flatMap: { - (f: (a: A) => StateReaderTaskEither): ( - ma: StateReaderTaskEither +export declare const flatMapReaderTaskEither: { + (f: (a: A) => RTE.ReaderTaskEither): ( + self: StateReaderTaskEither ) => StateReaderTaskEither ( - ma: StateReaderTaskEither, - f: (a: A) => StateReaderTaskEither + self: StateReaderTaskEither, + f: (a: A) => RTE.ReaderTaskEither ): StateReaderTaskEither } ``` -Added in v2.14.0 - -## flatMapIO - -**Signature** - -```ts -export declare const flatMapIO: { - (f: (a: A) => IO): (self: StateReaderTaskEither) => StateReaderTaskEither - (self: StateReaderTaskEither, f: (a: A) => IO): StateReaderTaskEither -} -``` - Added in v2.16.0 -## flatMapReader +## flatMapState **Signature** ```ts -export declare const flatMapReader: { - (f: (a: A) => R.Reader): ( - self: StateReaderTaskEither - ) => StateReaderTaskEither - (self: StateReaderTaskEither, f: (a: A) => R.Reader): StateReaderTaskEither< - S, - R1 & R2, - E, - B - > +export declare const flatMapState: { + (f: (a: A) => State): ( + self: StateReaderTaskEither + ) => StateReaderTaskEither + (self: StateReaderTaskEither, f: (a: A) => State): StateReaderTaskEither } ``` diff --git a/docs/modules/TaskEither.ts.md b/docs/modules/TaskEither.ts.md index 519560854..cb4b076f9 100644 --- a/docs/modules/TaskEither.ts.md +++ b/docs/modules/TaskEither.ts.md @@ -143,6 +143,7 @@ Added in v2.0.0 - [flatMap](#flatmap) - [flatMapEither](#flatmapeither) - [flatMapIO](#flatmapio) + - [flatMapIOEither](#flatmapioeither) - [flatMapNullable](#flatmapnullable) - [flatMapOption](#flatmapoption) - [flatMapTask](#flatmaptask) @@ -1754,6 +1755,8 @@ Added in v2.10.0 ## chainIOEitherK +Alias of `flatMapIOEither`. + **Signature** ```ts @@ -1766,6 +1769,8 @@ Added in v2.4.0 ## chainIOEitherKW +Alias of `flatMapIOEither`. + Less strict version of [`chainIOEitherK`](#chainioeitherk). The `W` suffix (short for **W**idening) means that the error types will be merged. @@ -1845,6 +1850,19 @@ export declare const flatMapIO: { Added in v2.15.0 +## flatMapIOEither + +**Signature** + +```ts +export declare const flatMapIOEither: { + (f: (a: A) => IOEither): (self: TaskEither) => TaskEither + (self: TaskEither, f: (a: A) => IOEither): TaskEither +} +``` + +Added in v2.16.0 + ## flatMapNullable **Signature**