From 21d033e8fa47339febaa96dfbe78b471dec646ce Mon Sep 17 00:00:00 2001 From: Alexander Gribochkin Date: Sat, 6 May 2023 12:46:50 +0300 Subject: [PATCH] docs: Regenerated --- README.md | 2 +- .../classes/internal_.EitherConstructor.md | 60 +++++--------- docs/api/classes/internal_.Just.md | 76 ++--------------- docs/api/classes/internal_.Left.md | 76 ++++++++--------- .../api/classes/internal_.MaybeConstructor.md | 82 ++----------------- docs/api/classes/internal_.None.md | 76 ++--------------- docs/api/classes/internal_.Right.md | 76 ++++++++--------- docs/api/modules.md | 4 +- docs/api/modules/internal_.md | 20 ++--- src/index.ts | 3 +- 10 files changed, 132 insertions(+), 343 deletions(-) diff --git a/README.md b/README.md index ce56398..4c17d84 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ 1. **Small** and **Tree-Shakable**. Either - 3kb minified, Maybe - 3kb minified, can be imported separately 2. **No dependencies**. -3. **Memory-Efficient**. 4 bytes overhead per instance (only class pointer) +3. **Memory-Efficient**. 8 bytes overhead per instance (only class pointer) 4. **Tested**. 100% coverage 5. **Practical**. Just 2 wrappers: Either and Maybe - easy for non-fp people diff --git a/docs/api/classes/internal_.EitherConstructor.md b/docs/api/classes/internal_.EitherConstructor.md index e781821..234b66b 100644 --- a/docs/api/classes/internal_.EitherConstructor.md +++ b/docs/api/classes/internal_.EitherConstructor.md @@ -31,10 +31,6 @@ - [constructor](internal_.EitherConstructor.md#constructor) -### Accessors - -- [[toStringTag]](internal_.EitherConstructor.md#[tostringtag]) - ### Methods - [apply](internal_.EitherConstructor.md#apply) @@ -75,20 +71,6 @@ | `L` | | `R` | -## Accessors - -### [toStringTag] - -• `get` **[toStringTag]**(): `string` - -#### Returns - -`string` - -#### Defined in - -dist/either.d.ts:13 - ## Methods ### apply @@ -121,7 +103,7 @@ dist/either.d.ts:13 #### Defined in -dist/either.d.ts:20 +dist/either.d.ts:19 ▸ **apply**<`A`, `B`, `P`\>(`this`, `map`, `...parameters`): [`Either`](../modules/internal_.md#either)<`L`, `B`\> @@ -151,7 +133,7 @@ dist/either.d.ts:20 #### Defined in -dist/either.d.ts:21 +dist/either.d.ts:20 ___ @@ -184,7 +166,7 @@ ___ #### Defined in -dist/either.d.ts:25 +dist/either.d.ts:24 ___ @@ -202,7 +184,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`EitherConstructor`](internal_.EitherConstructor.md)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | +| `this` | [`Either`](../modules/internal_.md#either)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | #### Returns @@ -214,7 +196,7 @@ ___ #### Defined in -dist/either.d.ts:26 +dist/either.d.ts:25 ___ @@ -242,7 +224,7 @@ ___ #### Defined in -dist/either.d.ts:24 +dist/either.d.ts:23 ___ @@ -270,7 +252,7 @@ ___ #### Defined in -dist/either.d.ts:27 +dist/either.d.ts:26 ___ @@ -303,7 +285,7 @@ ___ #### Defined in -dist/either.d.ts:23 +dist/either.d.ts:22 ___ @@ -327,7 +309,7 @@ ___ #### Defined in -dist/either.d.ts:28 +dist/either.d.ts:27 ___ @@ -369,7 +351,7 @@ this is Left #### Defined in -dist/either.d.ts:14 +dist/either.d.ts:13 ___ @@ -383,7 +365,7 @@ this is Right #### Defined in -dist/either.d.ts:15 +dist/either.d.ts:14 ___ @@ -415,7 +397,7 @@ ___ #### Defined in -dist/either.d.ts:17 +dist/either.d.ts:16 ___ @@ -447,7 +429,7 @@ ___ #### Defined in -dist/either.d.ts:19 +dist/either.d.ts:18 ___ @@ -475,7 +457,7 @@ ___ #### Defined in -dist/either.d.ts:18 +dist/either.d.ts:17 ___ @@ -499,7 +481,7 @@ ___ #### Defined in -dist/either.d.ts:29 +dist/either.d.ts:28 ___ @@ -513,7 +495,7 @@ ___ #### Defined in -dist/either.d.ts:32 +dist/either.d.ts:31 ___ @@ -527,7 +509,7 @@ ___ #### Defined in -dist/either.d.ts:22 +dist/either.d.ts:21 ___ @@ -568,7 +550,7 @@ ___ #### Defined in -dist/either.d.ts:33 +dist/either.d.ts:32 ___ @@ -592,7 +574,7 @@ ___ #### Defined in -dist/either.d.ts:31 +dist/either.d.ts:30 ___ @@ -622,7 +604,7 @@ ___ #### Defined in -dist/either.d.ts:16 +dist/either.d.ts:15 ___ @@ -649,7 +631,7 @@ ___ #### Defined in -dist/either.d.ts:30 +dist/either.d.ts:29 ___ diff --git a/docs/api/classes/internal_.Just.md b/docs/api/classes/internal_.Just.md index dda0f1f..8009225 100644 --- a/docs/api/classes/internal_.Just.md +++ b/docs/api/classes/internal_.Just.md @@ -57,8 +57,6 @@ - [unwrapOr](internal_.Just.md#unwrapor) - [zip](internal_.Just.md#zip) - [create](internal_.Just.md#create) -- [just](internal_.Just.md#just) -- [none](internal_.Just.md#none) ## Constructors @@ -104,10 +102,6 @@ dist/maybe.d.ts:37 `string` -#### Overrides - -MaybeConstructor.\_\_@toStringTag@216 - #### Defined in dist/maybe.d.ts:39 @@ -180,7 +174,7 @@ dist/maybe.d.ts:41 #### Defined in -dist/maybe.d.ts:15 +dist/maybe.d.ts:16 ▸ **apply**<`A`, `B`, `P`\>(`this`, `argument`, `...parameters`): [`Maybe`](../modules/internal_.md#maybe)<`B`\> @@ -210,7 +204,7 @@ dist/maybe.d.ts:15 #### Defined in -dist/maybe.d.ts:16 +dist/maybe.d.ts:17 ___ @@ -260,7 +254,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`MaybeConstructor`](internal_.MaybeConstructor.md)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | +| `this` | [`Maybe`](../modules/internal_.md#maybe)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | #### Returns @@ -460,7 +454,7 @@ this is Just #### Defined in -dist/maybe.d.ts:11 +dist/maybe.d.ts:12 ___ @@ -478,7 +472,7 @@ this is None #### Defined in -dist/maybe.d.ts:12 +dist/maybe.d.ts:13 ___ @@ -508,7 +502,7 @@ ___ #### Defined in -dist/maybe.d.ts:13 +dist/maybe.d.ts:14 ___ @@ -540,7 +534,7 @@ ___ #### Defined in -dist/maybe.d.ts:14 +dist/maybe.d.ts:15 ___ @@ -663,7 +657,7 @@ ___ #### Defined in -dist/maybe.d.ts:10 +dist/maybe.d.ts:11 ___ @@ -720,57 +714,3 @@ ___ #### Defined in dist/maybe.d.ts:38 - -___ - -### just - -▸ `Static` **just**<`T`\>(`value`): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Inherited from - -[MaybeConstructor](internal_.MaybeConstructor.md).[just](internal_.MaybeConstructor.md#just) - -#### Defined in - -dist/maybe.d.ts:9 - -___ - -### none - -▸ `Static` **none**<`T`\>(): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `never` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Inherited from - -[MaybeConstructor](internal_.MaybeConstructor.md).[none](internal_.MaybeConstructor.md#none) - -#### Defined in - -dist/maybe.d.ts:8 diff --git a/docs/api/classes/internal_.Left.md b/docs/api/classes/internal_.Left.md index 0331f50..7199260 100644 --- a/docs/api/classes/internal_.Left.md +++ b/docs/api/classes/internal_.Left.md @@ -85,7 +85,7 @@ #### Defined in -dist/either.d.ts:46 +dist/either.d.ts:47 ## Properties @@ -99,7 +99,7 @@ SerializedLeft.left #### Defined in -dist/either.d.ts:41 +dist/either.d.ts:40 ## Accessors @@ -111,13 +111,9 @@ dist/either.d.ts:41 `string` -#### Overrides - -EitherConstructor.\_\_@toStringTag@216 - #### Defined in -dist/either.d.ts:43 +dist/either.d.ts:42 ___ @@ -135,7 +131,7 @@ SerializedLeft.name #### Defined in -dist/either.d.ts:44 +dist/either.d.ts:43 ___ @@ -153,7 +149,7 @@ SerializedLeft.type #### Defined in -dist/either.d.ts:45 +dist/either.d.ts:46 ## Methods @@ -187,7 +183,7 @@ dist/either.d.ts:45 #### Defined in -dist/either.d.ts:20 +dist/either.d.ts:19 ▸ **apply**<`A`, `B`, `P`\>(`this`, `map`, `...parameters`): [`Either`](../modules/internal_.md#either)<`L`, `B`\> @@ -217,7 +213,7 @@ dist/either.d.ts:20 #### Defined in -dist/either.d.ts:21 +dist/either.d.ts:20 ___ @@ -250,7 +246,7 @@ ___ #### Defined in -dist/either.d.ts:25 +dist/either.d.ts:24 ___ @@ -268,7 +264,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`EitherConstructor`](internal_.EitherConstructor.md)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | +| `this` | [`Either`](../modules/internal_.md#either)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | #### Returns @@ -280,7 +276,7 @@ ___ #### Defined in -dist/either.d.ts:26 +dist/either.d.ts:25 ___ @@ -312,7 +308,7 @@ ___ #### Defined in -dist/either.d.ts:24 +dist/either.d.ts:23 ___ @@ -344,7 +340,7 @@ ___ #### Defined in -dist/either.d.ts:27 +dist/either.d.ts:26 ___ @@ -377,7 +373,7 @@ ___ #### Defined in -dist/either.d.ts:23 +dist/either.d.ts:22 ___ @@ -401,43 +397,43 @@ ___ #### Defined in -dist/either.d.ts:28 +dist/either.d.ts:27 ___ ### getLeft -▸ **getLeft**(): `undefined` \| `L` +▸ **getLeft**(): `L` #### Returns -`undefined` \| `L` +`L` -#### Inherited from +#### Overrides [EitherConstructor](internal_.EitherConstructor.md).[getLeft](internal_.EitherConstructor.md#getleft) #### Defined in -dist/either.d.ts:11 +dist/either.d.ts:45 ___ ### getRight -▸ **getRight**(): `undefined` \| `R` +▸ **getRight**(): `undefined` #### Returns -`undefined` \| `R` +`undefined` -#### Inherited from +#### Overrides [EitherConstructor](internal_.EitherConstructor.md).[getRight](internal_.EitherConstructor.md#getright) #### Defined in -dist/either.d.ts:10 +dist/either.d.ts:44 ___ @@ -455,7 +451,7 @@ this is Left #### Defined in -dist/either.d.ts:14 +dist/either.d.ts:13 ___ @@ -473,7 +469,7 @@ this is Right #### Defined in -dist/either.d.ts:15 +dist/either.d.ts:14 ___ @@ -505,7 +501,7 @@ ___ #### Defined in -dist/either.d.ts:17 +dist/either.d.ts:16 ___ @@ -537,7 +533,7 @@ ___ #### Defined in -dist/either.d.ts:19 +dist/either.d.ts:18 ___ @@ -569,7 +565,7 @@ ___ #### Defined in -dist/either.d.ts:18 +dist/either.d.ts:17 ___ @@ -593,7 +589,7 @@ ___ #### Defined in -dist/either.d.ts:29 +dist/either.d.ts:28 ___ @@ -611,7 +607,7 @@ ___ #### Defined in -dist/either.d.ts:32 +dist/either.d.ts:31 ___ @@ -629,7 +625,7 @@ ___ #### Defined in -dist/either.d.ts:22 +dist/either.d.ts:21 ___ @@ -678,7 +674,7 @@ ___ #### Defined in -dist/either.d.ts:33 +dist/either.d.ts:32 ___ @@ -692,7 +688,7 @@ ___ #### Defined in -dist/either.d.ts:47 +dist/either.d.ts:48 ___ @@ -716,7 +712,7 @@ ___ #### Defined in -dist/either.d.ts:31 +dist/either.d.ts:30 ___ @@ -746,7 +742,7 @@ ___ #### Defined in -dist/either.d.ts:16 +dist/either.d.ts:15 ___ @@ -777,7 +773,7 @@ ___ #### Defined in -dist/either.d.ts:30 +dist/either.d.ts:29 ___ @@ -804,7 +800,7 @@ ___ #### Defined in -dist/either.d.ts:42 +dist/either.d.ts:41 ___ diff --git a/docs/api/classes/internal_.MaybeConstructor.md b/docs/api/classes/internal_.MaybeConstructor.md index 0c27714..49238f1 100644 --- a/docs/api/classes/internal_.MaybeConstructor.md +++ b/docs/api/classes/internal_.MaybeConstructor.md @@ -30,10 +30,6 @@ - [constructor](internal_.MaybeConstructor.md#constructor) -### Accessors - -- [[toStringTag]](internal_.MaybeConstructor.md#[tostringtag]) - ### Methods - [apply](internal_.MaybeConstructor.md#apply) @@ -53,8 +49,6 @@ - [unwrap](internal_.MaybeConstructor.md#unwrap) - [unwrapOr](internal_.MaybeConstructor.md#unwrapor) - [zip](internal_.MaybeConstructor.md#zip) -- [just](internal_.MaybeConstructor.md#just) -- [none](internal_.MaybeConstructor.md#none) ## Constructors @@ -68,20 +62,6 @@ | :------ | | `T` | -## Accessors - -### [toStringTag] - -• `get` **[toStringTag]**(): `string` - -#### Returns - -`string` - -#### Defined in - -dist/maybe.d.ts:17 - ## Methods ### apply @@ -114,7 +94,7 @@ dist/maybe.d.ts:17 #### Defined in -dist/maybe.d.ts:15 +dist/maybe.d.ts:16 ▸ **apply**<`A`, `B`, `P`\>(`this`, `argument`, `...parameters`): [`Maybe`](../modules/internal_.md#maybe)<`B`\> @@ -144,7 +124,7 @@ dist/maybe.d.ts:15 #### Defined in -dist/maybe.d.ts:16 +dist/maybe.d.ts:17 ___ @@ -190,7 +170,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`MaybeConstructor`](internal_.MaybeConstructor.md)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | +| `this` | [`Maybe`](../modules/internal_.md#maybe)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | #### Returns @@ -366,7 +346,7 @@ this is Just #### Defined in -dist/maybe.d.ts:11 +dist/maybe.d.ts:12 ___ @@ -380,7 +360,7 @@ this is None #### Defined in -dist/maybe.d.ts:12 +dist/maybe.d.ts:13 ___ @@ -410,7 +390,7 @@ ___ #### Defined in -dist/maybe.d.ts:13 +dist/maybe.d.ts:14 ___ @@ -442,7 +422,7 @@ ___ #### Defined in -dist/maybe.d.ts:14 +dist/maybe.d.ts:15 ___ @@ -547,7 +527,7 @@ ___ #### Defined in -dist/maybe.d.ts:10 +dist/maybe.d.ts:11 ___ @@ -574,49 +554,3 @@ ___ #### Defined in dist/maybe.d.ts:23 - -___ - -### just - -▸ `Static` **just**<`T`\>(`value`): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Defined in - -dist/maybe.d.ts:9 - -___ - -### none - -▸ `Static` **none**<`T`\>(): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `never` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Defined in - -dist/maybe.d.ts:8 diff --git a/docs/api/classes/internal_.None.md b/docs/api/classes/internal_.None.md index 0f7643d..8e71714 100644 --- a/docs/api/classes/internal_.None.md +++ b/docs/api/classes/internal_.None.md @@ -57,8 +57,6 @@ - [unwrapOr](internal_.None.md#unwrapor) - [zip](internal_.None.md#zip) - [create](internal_.None.md#create) -- [just](internal_.None.md#just) -- [none](internal_.None.md#none) ## Constructors @@ -100,10 +98,6 @@ dist/maybe.d.ts:50 `string` -#### Overrides - -MaybeConstructor.\_\_@toStringTag@216 - #### Defined in dist/maybe.d.ts:52 @@ -176,7 +170,7 @@ dist/maybe.d.ts:54 #### Defined in -dist/maybe.d.ts:15 +dist/maybe.d.ts:16 ▸ **apply**<`A`, `B`, `P`\>(`this`, `argument`, `...parameters`): [`Maybe`](../modules/internal_.md#maybe)<`B`\> @@ -206,7 +200,7 @@ dist/maybe.d.ts:15 #### Defined in -dist/maybe.d.ts:16 +dist/maybe.d.ts:17 ___ @@ -256,7 +250,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`MaybeConstructor`](internal_.MaybeConstructor.md)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | +| `this` | [`Maybe`](../modules/internal_.md#maybe)<[`MaybePromiseLike`](../modules.md#maybepromiselike)<`X`\>\> | #### Returns @@ -456,7 +450,7 @@ this is Just #### Defined in -dist/maybe.d.ts:11 +dist/maybe.d.ts:12 ___ @@ -474,7 +468,7 @@ this is None #### Defined in -dist/maybe.d.ts:12 +dist/maybe.d.ts:13 ___ @@ -504,7 +498,7 @@ ___ #### Defined in -dist/maybe.d.ts:13 +dist/maybe.d.ts:14 ___ @@ -536,7 +530,7 @@ ___ #### Defined in -dist/maybe.d.ts:14 +dist/maybe.d.ts:15 ___ @@ -659,7 +653,7 @@ ___ #### Defined in -dist/maybe.d.ts:10 +dist/maybe.d.ts:11 ___ @@ -710,57 +704,3 @@ ___ #### Defined in dist/maybe.d.ts:51 - -___ - -### just - -▸ `Static` **just**<`T`\>(`value`): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Inherited from - -[MaybeConstructor](internal_.MaybeConstructor.md).[just](internal_.MaybeConstructor.md#just) - -#### Defined in - -dist/maybe.d.ts:9 - -___ - -### none - -▸ `Static` **none**<`T`\>(): [`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `never` | - -#### Returns - -[`Maybe`](../modules/internal_.md#maybe)<`T`\> - -#### Inherited from - -[MaybeConstructor](internal_.MaybeConstructor.md).[none](internal_.MaybeConstructor.md#none) - -#### Defined in - -dist/maybe.d.ts:8 diff --git a/docs/api/classes/internal_.Right.md b/docs/api/classes/internal_.Right.md index 3cc5c73..9313c32 100644 --- a/docs/api/classes/internal_.Right.md +++ b/docs/api/classes/internal_.Right.md @@ -85,7 +85,7 @@ #### Defined in -dist/either.d.ts:60 +dist/either.d.ts:63 ## Properties @@ -99,7 +99,7 @@ SerializedRight.right #### Defined in -dist/either.d.ts:55 +dist/either.d.ts:56 ## Accessors @@ -111,13 +111,9 @@ dist/either.d.ts:55 `string` -#### Overrides - -EitherConstructor.\_\_@toStringTag@216 - #### Defined in -dist/either.d.ts:57 +dist/either.d.ts:58 ___ @@ -135,7 +131,7 @@ SerializedRight.name #### Defined in -dist/either.d.ts:58 +dist/either.d.ts:59 ___ @@ -153,7 +149,7 @@ SerializedRight.type #### Defined in -dist/either.d.ts:59 +dist/either.d.ts:60 ## Methods @@ -187,7 +183,7 @@ dist/either.d.ts:59 #### Defined in -dist/either.d.ts:20 +dist/either.d.ts:19 ▸ **apply**<`A`, `B`, `P`\>(`this`, `map`, `...parameters`): [`Either`](../modules/internal_.md#either)<`L`, `B`\> @@ -217,7 +213,7 @@ dist/either.d.ts:20 #### Defined in -dist/either.d.ts:21 +dist/either.d.ts:20 ___ @@ -250,7 +246,7 @@ ___ #### Defined in -dist/either.d.ts:25 +dist/either.d.ts:24 ___ @@ -268,7 +264,7 @@ ___ | Name | Type | | :------ | :------ | -| `this` | [`EitherConstructor`](internal_.EitherConstructor.md)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | +| `this` | [`Either`](../modules/internal_.md#either)<`L`, [`MaybePromiseLike`](../modules.md#maybepromiselike)<`T`\>\> | #### Returns @@ -280,7 +276,7 @@ ___ #### Defined in -dist/either.d.ts:26 +dist/either.d.ts:25 ___ @@ -312,7 +308,7 @@ ___ #### Defined in -dist/either.d.ts:24 +dist/either.d.ts:23 ___ @@ -344,7 +340,7 @@ ___ #### Defined in -dist/either.d.ts:27 +dist/either.d.ts:26 ___ @@ -377,7 +373,7 @@ ___ #### Defined in -dist/either.d.ts:23 +dist/either.d.ts:22 ___ @@ -401,43 +397,43 @@ ___ #### Defined in -dist/either.d.ts:28 +dist/either.d.ts:27 ___ ### getLeft -▸ **getLeft**(): `undefined` \| `L` +▸ **getLeft**(): `undefined` #### Returns -`undefined` \| `L` +`undefined` -#### Inherited from +#### Overrides [EitherConstructor](internal_.EitherConstructor.md).[getLeft](internal_.EitherConstructor.md#getleft) #### Defined in -dist/either.d.ts:11 +dist/either.d.ts:62 ___ ### getRight -▸ **getRight**(): `undefined` \| `R` +▸ **getRight**(): `R` #### Returns -`undefined` \| `R` +`R` -#### Inherited from +#### Overrides [EitherConstructor](internal_.EitherConstructor.md).[getRight](internal_.EitherConstructor.md#getright) #### Defined in -dist/either.d.ts:10 +dist/either.d.ts:61 ___ @@ -455,7 +451,7 @@ this is Left #### Defined in -dist/either.d.ts:14 +dist/either.d.ts:13 ___ @@ -473,7 +469,7 @@ this is Right #### Defined in -dist/either.d.ts:15 +dist/either.d.ts:14 ___ @@ -505,7 +501,7 @@ ___ #### Defined in -dist/either.d.ts:17 +dist/either.d.ts:16 ___ @@ -537,7 +533,7 @@ ___ #### Defined in -dist/either.d.ts:19 +dist/either.d.ts:18 ___ @@ -569,7 +565,7 @@ ___ #### Defined in -dist/either.d.ts:18 +dist/either.d.ts:17 ___ @@ -593,7 +589,7 @@ ___ #### Defined in -dist/either.d.ts:29 +dist/either.d.ts:28 ___ @@ -611,7 +607,7 @@ ___ #### Defined in -dist/either.d.ts:32 +dist/either.d.ts:31 ___ @@ -629,7 +625,7 @@ ___ #### Defined in -dist/either.d.ts:22 +dist/either.d.ts:21 ___ @@ -678,7 +674,7 @@ ___ #### Defined in -dist/either.d.ts:33 +dist/either.d.ts:32 ___ @@ -692,7 +688,7 @@ ___ #### Defined in -dist/either.d.ts:61 +dist/either.d.ts:64 ___ @@ -716,7 +712,7 @@ ___ #### Defined in -dist/either.d.ts:31 +dist/either.d.ts:30 ___ @@ -746,7 +742,7 @@ ___ #### Defined in -dist/either.d.ts:16 +dist/either.d.ts:15 ___ @@ -777,7 +773,7 @@ ___ #### Defined in -dist/either.d.ts:30 +dist/either.d.ts:29 ___ @@ -804,7 +800,7 @@ ___ #### Defined in -dist/either.d.ts:56 +dist/either.d.ts:57 ___ diff --git a/docs/api/modules.md b/docs/api/modules.md index 3441477..66b2034 100644 --- a/docs/api/modules.md +++ b/docs/api/modules.md @@ -182,7 +182,7 @@ dist/index.d.ts:29 ### Either -• **Either**: `Readonly`<{ `aggregateError`: (`values`: [`Either`](modules/internal_.md#either)<`T`, `unknown`\>[], `message`: `undefined` \| `string` \| (`lefts`: `T`[]) => `undefined` \| `string`) => `AggregateError` \| `undefined` ; `catch`: (`method`: () => [`Either`](modules/internal_.md#either)<`L`, `R`\>) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `catchAsync`: (`method`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`L`, `R`\>\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `R`\>\> ; `chain`: (`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`never`, `NR`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `NR`\>\>(`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`NL`, `never`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`NL` \| `L`, `R`\>\>(`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`NL`, `NR`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`NL` \| `L`, `NR`\>\> ; `fromJSON`: (`serialized`: [`SerializedEither`](modules/internal_.md#serializedeither)<`L`, `R`\>) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `fromMaybe`: (`maybe`: [`Maybe`](modules/internal_.md#maybe)<`R`\>, `leftValue`: `L`) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `fromPromise`: (`promise`: [`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `T`\>\> ; `fromPromiseSettledResult`: (`result`: `PromiseSettledResult`<`T`\>) => [`Either`](modules/internal_.md#either)<`L`, `T`\> ; `fromTry`: (`callback`: () => `T`) => [`Either`](modules/internal_.md#either)<`L`, `T`\> ; `fromTryAsync`: (`callback`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `T`\>\> ; `isEither`: (`value`: `unknown`) => value is Either ; `left`: (`value`: `T`) => [`Either`](modules/internal_.md#either)<`T`, `R`\> ; `merge`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`, [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2`, [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3`, [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4`, [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5`, [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`, [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`, `R`[]\> ; `mergeInMany`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`[], [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2`)[], [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3`)[], [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3` \| `L4`)[], [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`EitherConstructor`](classes/internal_.EitherConstructor.md)<(`L1` \| `L2` \| `L3` \| `L4` \| `L5`)[], [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`)[], [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`[], `R`[]\> ; `mergeInOne`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`, [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2`, [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3`, [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4`, [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5`, [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`, [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`, `R`[]\> ; `right`: (`right`: `T_1`) => [`Either`](modules/internal_.md#either)<`L`, `T_1`\> ; `wrap`: (`method`: (...`parameters`: `P`) => [`Either`](modules/internal_.md#either)<`L`, `R`\>) => (`this`: `any`, ...`parameters`: `P`) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `wrapAsync`: (`method`: (...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`L`, `R`\>\>) => (`this`: `any`, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `R`\>\> }\> +• **Either**: `Readonly`<{ `aggregateError`: (`values`: [`Either`](modules/internal_.md#either)<`T`, `unknown`\>[], `message`: `undefined` \| `string` \| (`lefts`: `T`[]) => `undefined` \| `string`) => `AggregateError` \| `undefined` ; `catch`: (`method`: () => [`Either`](modules/internal_.md#either)<`L`, `R`\>) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `catchAsync`: (`method`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`L`, `R`\>\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `R`\>\> ; `chain`: (`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`never`, `NR`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `NR`\>\>(`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`NL`, `never`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`NL` \| `L`, `R`\>\>(`map`: (`value`: `R`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`NL`, `NR`\>\>, ...`parameters`: `P`) => (`either`: [`Either`](modules/internal_.md#either)<`L`, `R`\>, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`NL` \| `L`, `NR`\>\> ; `fromJSON`: (`serialized`: [`SerializedEither`](modules/internal_.md#serializedeither)<`L`, `R`\>) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `fromMaybe`: (`maybe`: [`Maybe`](modules/internal_.md#maybe)<`R`\>, `leftValue`: `L`) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `fromPromise`: (`promise`: [`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `T`\>\> ; `fromPromiseSettledResult`: (`result`: `PromiseSettledResult`<`T`\>) => [`Either`](modules/internal_.md#either)<`L`, `T`\> ; `fromTry`: (`callback`: () => `T`) => [`Either`](modules/internal_.md#either)<`L`, `T`\> ; `fromTryAsync`: (`callback`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `T`\>\> ; `isEither`: (`value`: `unknown`) => value is Either ; `left`: (`value`: `T`) => [`Either`](modules/internal_.md#either)<`T`, `R`\> ; `merge`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`, [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2`, [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3`, [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4`, [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5`, [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`, [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`, `R`[]\> ; `mergeInMany`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`[], [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2`)[], [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3`)[], [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3` \| `L4`)[], [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3` \| `L4` \| `L5`)[], [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<(`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`)[], [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`[], `R`[]\> ; `mergeInOne`: (`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>]) => [`Either`](modules/internal_.md#either)<`L1`, [`R1`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2`, [`R1`, `R2`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3`, [`R1`, `R2`, `R3`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4`, [`R1`, `R2`, `R3`, `R4`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5`, [`R1`, `R2`, `R3`, `R4`, `R5`]\>(`values`: [[`Either`](modules/internal_.md#either)<`L1`, `R1`\>, [`Either`](modules/internal_.md#either)<`L2`, `R2`\>, [`Either`](modules/internal_.md#either)<`L3`, `R3`\>, [`Either`](modules/internal_.md#either)<`L4`, `R4`\>, [`Either`](modules/internal_.md#either)<`L5`, `R5`\>, [`Either`](modules/internal_.md#either)<`L6`, `R6`\>]) => [`Either`](modules/internal_.md#either)<`L1` \| `L2` \| `L3` \| `L4` \| `L5` \| `L6`, [`R1`, `R2`, `R3`, `R4`, `R5`, `R6`]\>(`values`: [`Either`](modules/internal_.md#either)<`L`, `R`\>[]) => [`Either`](modules/internal_.md#either)<`L`, `R`[]\> ; `right`: (`right`: `T_1`) => [`Either`](modules/internal_.md#either)<`L`, `T_1`\> ; `wrap`: (`method`: (...`parameters`: `P`) => [`Either`](modules/internal_.md#either)<`L`, `R`\>) => (`this`: `any`, ...`parameters`: `P`) => [`Either`](modules/internal_.md#either)<`L`, `R`\> ; `wrapAsync`: (`method`: (...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Either`](modules/internal_.md#either)<`L`, `R`\>\>) => (`this`: `any`, ...`parameters`: `P`) => `Promise`<[`Either`](modules/internal_.md#either)<`L`, `R`\>\> }\> **`Deprecated`** @@ -198,7 +198,7 @@ ___ ### Maybe -• **Maybe**: `Readonly`<{ `asyncIterator`: (`callback`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Maybe`](modules/internal_.md#maybe)<[`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>\>\>) => `AsyncGenerator`<`T`, `void`, `void`\> ; `chain`: (`map`: (`v`: `A`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Maybe`](modules/internal_.md#maybe)<`B`\>\>, ...`parameters`: `P`) => (`maybe`: [`Maybe`](modules/internal_.md#maybe)<`A`\>) => `Promise`<[`Maybe`](modules/internal_.md#maybe)<`B`\>\> ; `fromEitherLeft`: (`either`: [`Either`](modules/internal_.md#either)<`L`, `unknown`\>) => [`Maybe`](modules/internal_.md#maybe)<`L`\> ; `fromEitherRight`: (`either`: [`Either`](modules/internal_.md#either)<`unknown`, `R`\>) => [`Maybe`](modules/internal_.md#maybe)<`R`\> ; `fromJSON`: (`serialized`: [`SerializedMaybe`](modules/internal_.md#serializedmaybe)<`T`\>) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `fromNullable`: (`value`: [`Nullable`](modules.md#nullable)<`T`\>) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `isMaybe`: (`value`: `unknown`) => value is Maybe ; `iterator`: (`callback`: () => [`Maybe`](modules/internal_.md#maybe)<`T`\>) => `Generator`<`T`, `void`, `void`\> ; `just`: (`value`: `T`) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `merge`: (`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>, [`Maybe`](modules/internal_.md#maybe)<`V5`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`, `V5`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>, [`Maybe`](modules/internal_.md#maybe)<`V5`\>, [`Maybe`](modules/internal_.md#maybe)<`V6`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`, `V5`, `V6`]\>(`values`: [`Maybe`](modules/internal_.md#maybe)<`T`\>[]) => [`Maybe`](modules/internal_.md#maybe)<`T`[]\> ; `none`: () => [`Maybe`](modules/internal_.md#maybe)<`T_1`\> }\> +• **Maybe**: `Readonly`<{ `asyncIterator`: (`callback`: () => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Maybe`](modules/internal_.md#maybe)<[`MaybePromiseLike`](modules.md#maybepromiselike)<`T`\>\>\>) => `AsyncGenerator`<`T`, `void`, `void`\> ; `chain`: (`map`: (`v`: `A`, ...`parameters`: `P`) => [`MaybePromiseLike`](modules.md#maybepromiselike)<[`Maybe`](modules/internal_.md#maybe)<`B`\>\>, ...`parameters`: `P`) => (`maybe`: [`Maybe`](modules/internal_.md#maybe)<`A`\>) => `Promise`<[`Maybe`](modules/internal_.md#maybe)<`B`\>\> ; `fromEitherLeft`: (`either`: [`Either`](modules/internal_.md#either)<`L`, `unknown`\>) => [`Maybe`](modules/internal_.md#maybe)<`L`\> ; `fromEitherRight`: (`either`: [`Either`](modules/internal_.md#either)<`unknown`, `R`\>) => [`Maybe`](modules/internal_.md#maybe)<`R`\> ; `fromJSON`: (`serialized`: [`SerializedMaybe`](modules/internal_.md#serializedmaybe)<`T`\>) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `fromNullable`: (`value`: [`Nullable`](modules.md#nullable)<`T`\>) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `isMaybe`: (`value`: `unknown`) => value is Maybe ; `iterator`: (`callback`: () => [`Maybe`](modules/internal_.md#maybe)<`T`\>) => `Generator`<`T`, `void`, `void`\> ; `just`: (`value`: `T`) => [`Maybe`](modules/internal_.md#maybe)<`T`\> ; `merge`: (`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>, [`Maybe`](modules/internal_.md#maybe)<`V5`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`, `V5`]\>(`values`: [[`Maybe`](modules/internal_.md#maybe)<`V1`\>, [`Maybe`](modules/internal_.md#maybe)<`V2`\>, [`Maybe`](modules/internal_.md#maybe)<`V3`\>, [`Maybe`](modules/internal_.md#maybe)<`V4`\>, [`Maybe`](modules/internal_.md#maybe)<`V5`\>, [`Maybe`](modules/internal_.md#maybe)<`V6`\>]) => [`Maybe`](modules/internal_.md#maybe)<[`V1`, `V2`, `V3`, `V4`, `V5`, `V6`]\>(`values`: [`Maybe`](modules/internal_.md#maybe)<`T`\>[]) => [`Maybe`](modules/internal_.md#maybe)<`T`[]\> ; `none`: () => [`Maybe`](modules/internal_.md#maybe)<`T`\> }\> **`Deprecated`** diff --git a/docs/api/modules/internal_.md b/docs/api/modules/internal_.md index ebcac19..62a75ea 100644 --- a/docs/api/modules/internal_.md +++ b/docs/api/modules/internal_.md @@ -54,7 +54,7 @@ #### Defined in -dist/maybe.d.ts:3 +dist/maybe.d.ts:4 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -dist/maybe.d.ts:4 +dist/maybe.d.ts:3 ___ @@ -94,14 +94,14 @@ dist/either.d.ts:4 #### Type parameters -| Name | -| :------ | -| `L` | -| `R` | +| Name | Type | +| :------ | :------ | +| `L` | `unknown` | +| `R` | `unknown` | #### Defined in -dist/either.d.ts:63 +dist/either.d.ts:66 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -dist/either.d.ts:64 +dist/either.d.ts:67 ___ @@ -202,7 +202,7 @@ ___ #### Defined in -dist/either.d.ts:35 +dist/either.d.ts:34 ___ @@ -251,7 +251,7 @@ ___ #### Defined in -dist/either.d.ts:49 +dist/either.d.ts:50 ## Variables diff --git a/src/index.ts b/src/index.ts index cb477dc..09b3d74 100644 --- a/src/index.ts +++ b/src/index.ts @@ -45,7 +45,8 @@ export const Maybe = Object.freeze({ fromEitherRight: maybe.fromEitherRight, fromEitherLeft: maybe.fromEitherLeft, iterator: maybe.iterator, - asyncIterator: maybe.asyncIterator + asyncIterator: maybe.asyncIterator, + filterMap: maybe.filterMap }); export type {