docs: Regenerated

AlexXanderGrib · May 6, 2023 · 21d033e · 21d033e
1 parent 1866cc6
commit 21d033e
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 343 deletions.
diff --git 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
@@ -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<L, R\>
 
 #### Defined in
 
-dist/either.d.ts:14
+dist/either.d.ts:13
 
 ___
 
@@ -383,7 +365,7 @@ this is Right<L, R\>
 
 #### 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
@@ -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<T\>
 
 #### Defined in
 
-dist/maybe.d.ts:11
+dist/maybe.d.ts:12
 
 ___
 
@@ -478,7 +472,7 @@ this is None<T\>
 
 #### 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