happy-rusty
Advanced tools
happy-rusty - npm Package Compare versions
Comparing version 1.1.0 to 1.1.1
@@ -473,4 +473,2 @@ /** | ||
| * The type parameter is set to `never` because `None` does not hold a value. | ||
| * | ||
| * @extends {Option<never>} Extends the generic `Option` type with `never` to denote no value. | ||
| */ | ||
@@ -477,0 +475,0 @@ interface None extends Option<never> { |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / Err | ||
| [happy-rusty](../README.md) / Err | ||
@@ -16,6 +16,6 @@ # Function: Err() | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value that the result could potentially contain (not used in this case). | | ||
@@ -27,3 +27,3 @@ | `E` | The type of the error to be wrapped in the `Err` result. | | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `error` | `E` | The error to wrap as an `Err` result. | | ||
@@ -46,4 +46,4 @@ | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:855](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L855) | ||
| [prelude.ts:853](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L853) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / Ok | ||
| [happy-rusty](../README.md) / Ok | ||
@@ -16,6 +16,6 @@ # Function: Ok() | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value to be contained in the `Ok` result. | | ||
@@ -27,3 +27,3 @@ | `E` | The type of the error that the result could potentially contain (not used in this case). | | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `value` | `T` | The value to wrap as an `Ok` result. | | ||
@@ -46,4 +46,4 @@ | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:776](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L776) | ||
| [prelude.ts:774](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L774) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / promiseToResult | ||
| [happy-rusty](../README.md) / promiseToResult | ||
@@ -16,6 +16,6 @@ # Function: promiseToResult() | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Value | Description | | ||
| | :------ | :------ | :------ | | ||
| | Type Parameter | Default type | Description | | ||
| | ------ | ------ | ------ | | ||
| | `T` | - | The type of the value that the promise resolves to. | | ||
@@ -27,3 +27,3 @@ | `E` | `Error` | The type of the error that the promise may reject with, defaults to `Error`. | | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `p` | `Promise`\<`T`\> | The promise to convert into a `Result` type. | | ||
@@ -50,4 +50,4 @@ | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:959](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L959) | ||
| [prelude.ts:957](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L957) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / Some | ||
| [happy-rusty](../README.md) / Some | ||
@@ -16,6 +16,6 @@ # Function: Some() | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value to be wrapped in a `Some`. | | ||
@@ -26,3 +26,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `value` | `T` | The value to wrap as a `Some` option. | | ||
@@ -45,4 +45,4 @@ | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:627](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L627) | ||
| [prelude.ts:625](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L625) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / None | ||
| [happy-rusty](../README.md) / None | ||
@@ -18,5 +18,5 @@ # Interface: None | ||
| | Property | Modifier | Type | Description | Overrides | | ||
| | :------ | :------ | :------ | :------ | :------ | | ||
| | `[optionKindSymbol]` | `readonly` | `"None"` | When using `None` alone, the following overrides can make type inference more accurate. | [`Option`](Option.md).`[optionKindSymbol]` | | ||
| | Property | Modifier | Type | Description | Overrides | Defined in | | ||
| | ------ | ------ | ------ | ------ | ------ | ------ | | ||
| | `[optionKindSymbol]` | `readonly` | `"None"` | When using `None` alone, the following overrides can make type inference more accurate. | `Option.[optionKindSymbol]` | [prelude.ts:291](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L291) | | ||
@@ -34,6 +34,6 @@ ## Methods | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -44,3 +44,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The `Option` to return if `this` is `Some`. | | ||
@@ -58,5 +58,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:308](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L308) | ||
| [prelude.ts:306](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L306) | ||
@@ -74,6 +74,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the function. | | ||
@@ -84,3 +84,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => [`Option`](Option.md)\<`U`\> | A function that takes the contained value and returns an `Option`. | | ||
@@ -98,5 +98,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:309](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L309) | ||
| [prelude.ts:307](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L307) | ||
@@ -114,6 +114,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -124,3 +124,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The other `Option` to compare with. | | ||
@@ -138,5 +138,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:314](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L314) | ||
| [prelude.ts:312](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L312) | ||
@@ -156,3 +156,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `msg` | `string` | The error message to provide if the value is a `None`. | | ||
@@ -164,2 +164,6 @@ | ||
| #### Throws | ||
| Throws an error with the provided message if the Option is a `None`. | ||
| #### Inherited from | ||
@@ -169,10 +173,6 @@ | ||
| #### Throws | ||
| #### Defined in | ||
| Throws an error with the provided message if the Option is a `None`. | ||
| [prelude.ts:80](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L80) | ||
| #### Source | ||
| [enum/prelude.ts:80](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L80) | ||
| *** | ||
@@ -193,3 +193,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`value`) => `boolean` | A function that takes the contained value and returns a boolean. | | ||
@@ -205,5 +205,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:300](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L300) | ||
| [prelude.ts:298](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L298) | ||
@@ -230,5 +230,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:301](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L301) | ||
| [prelude.ts:299](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L299) | ||
@@ -249,3 +249,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `void` | A function to call with the contained value. | | ||
@@ -263,5 +263,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:267](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L267) | ||
| [prelude.ts:267](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L267) | ||
@@ -286,5 +286,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:59](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L59) | ||
| [prelude.ts:59](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L59) | ||
@@ -309,5 +309,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:54](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L54) | ||
| [prelude.ts:54](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L54) | ||
@@ -327,3 +327,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`value`) => `boolean` | A function that takes the contained value and returns a boolean. | | ||
@@ -339,5 +339,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:65](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L65) | ||
| [prelude.ts:65](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L65) | ||
@@ -354,6 +354,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function. | | ||
@@ -364,3 +364,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
@@ -376,5 +376,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:302](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L302) | ||
| [prelude.ts:300](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L300) | ||
@@ -391,6 +391,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default value. | | ||
@@ -401,3 +401,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `U` | The value to return if the Option is `None`. | | ||
@@ -414,5 +414,5 @@ | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:163](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L163) | ||
| [prelude.ts:163](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L163) | ||
@@ -429,6 +429,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default function. | | ||
@@ -439,3 +439,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultFn` | () => `U` | A function that returns the default value. | | ||
@@ -452,5 +452,5 @@ | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:171](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L171) | ||
| [prelude.ts:171](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L171) | ||
@@ -467,6 +467,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `E` | The type of the error value in the `Err` variant of the resulting `Result`. | | ||
@@ -477,3 +477,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `error` | `E` | The error value to use if the Option is a `None`. | | ||
@@ -489,5 +489,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:113](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L113) | ||
| [prelude.ts:113](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L113) | ||
@@ -504,6 +504,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `E` | The type of the error value in the `Err` variant of the resulting `Result`. | | ||
@@ -514,3 +514,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `err` | () => `E` | A function that returns the error value. | | ||
@@ -526,5 +526,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:120](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L120) | ||
| [prelude.ts:120](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L120) | ||
@@ -542,6 +542,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -552,3 +552,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The fallback `Option` to use if `this` is `None`. | | ||
@@ -566,5 +566,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:310](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L310) | ||
| [prelude.ts:308](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L308) | ||
@@ -582,6 +582,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -592,3 +592,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | () => [`Option`](Option.md)\<`T`\> | A function that produces an `Option`. | | ||
@@ -606,5 +606,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:311](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L311) | ||
| [prelude.ts:309](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L309) | ||
@@ -633,5 +633,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:298](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L298) | ||
| [prelude.ts:296](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L296) | ||
@@ -652,2 +652,6 @@ *** | ||
| #### Throws | ||
| Throws an error if the value is a `None`. | ||
| #### Inherited from | ||
@@ -657,10 +661,6 @@ | ||
| #### Throws | ||
| #### Defined in | ||
| Throws an error if the value is a `None`. | ||
| [prelude.ts:86](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L86) | ||
| #### Source | ||
| [enum/prelude.ts:86](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L86) | ||
| *** | ||
@@ -676,6 +676,6 @@ | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -686,3 +686,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `T` | The value to return if the Option is a `None`. | | ||
@@ -698,5 +698,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:295](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L295) | ||
| [prelude.ts:293](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L293) | ||
@@ -713,6 +713,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -723,3 +723,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | () => `T` | A function that returns the default value. | | ||
@@ -735,5 +735,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:296](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L296) | ||
| [prelude.ts:294](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L294) | ||
@@ -762,5 +762,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:306](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L306) | ||
| [prelude.ts:304](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L304) | ||
@@ -778,6 +778,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -788,3 +788,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The other `Option` to compare with. | | ||
@@ -802,5 +802,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:312](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L312) | ||
| [prelude.ts:310](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L310) | ||
@@ -819,6 +819,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -829,3 +829,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The other `Option` to zip with. | | ||
@@ -843,5 +843,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:304](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L304) | ||
| [prelude.ts:302](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L302) | ||
@@ -860,6 +860,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -871,3 +871,3 @@ | `R` | The return type of the combining function. | | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The other `Option` to zip with. | | ||
@@ -886,4 +886,4 @@ | `fn` | (`value`, `otherValue`) => `R` | The function to combine the values from both `Options`. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:305](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L305) | ||
| [prelude.ts:303](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L303) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / Option | ||
| [happy-rusty](../README.md) / Option | ||
@@ -24,14 +24,8 @@ # Interface: Option\<T\> | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value contained in the `Some` variant. | | ||
| ## Properties | ||
| | Property | Modifier | Type | Description | | ||
| | :------ | :------ | :------ | :------ | | ||
| | `[optionKindSymbol]` | `private` | `"Some"` \| `"None"` | Identify `Some` or `None`. | | ||
| ## Methods | ||
@@ -48,6 +42,6 @@ | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -58,3 +52,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The `Option` to return if `this` is `Some`. | | ||
@@ -68,5 +62,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:224](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L224) | ||
| [prelude.ts:224](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L224) | ||
@@ -84,6 +78,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the function. | | ||
@@ -94,3 +88,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => [`Option`](Option.md)\<`U`\> | A function that takes the contained value and returns an `Option`. | | ||
@@ -104,5 +98,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:233](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L233) | ||
| [prelude.ts:233](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L233) | ||
@@ -123,3 +117,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The other `Option` to compare with. | | ||
@@ -133,5 +127,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:277](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L277) | ||
| [prelude.ts:277](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L277) | ||
@@ -151,3 +145,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `msg` | `string` | The error message to provide if the value is a `None`. | | ||
@@ -163,5 +157,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:80](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L80) | ||
| [prelude.ts:80](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L80) | ||
@@ -183,3 +177,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`value`) => `boolean` | A function that takes the contained value and returns a boolean. | | ||
@@ -191,5 +185,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:142](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L142) | ||
| [prelude.ts:142](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L142) | ||
@@ -206,6 +200,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -216,3 +210,3 @@ | ||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | ------ | ------ | | ||
| | `this` | [`Option`](Option.md)\<[`Option`](Option.md)\<`T`\>\> | | ||
@@ -226,5 +220,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:148](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L148) | ||
| [prelude.ts:148](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L148) | ||
@@ -245,3 +239,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `void` | A function to call with the contained value. | | ||
@@ -255,5 +249,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:267](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L267) | ||
| [prelude.ts:267](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L267) | ||
@@ -274,5 +268,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:59](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L59) | ||
| [prelude.ts:59](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L59) | ||
@@ -293,5 +287,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:54](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L54) | ||
| [prelude.ts:54](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L54) | ||
@@ -311,3 +305,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`value`) => `boolean` | A function that takes the contained value and returns a boolean. | | ||
@@ -319,5 +313,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:65](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L65) | ||
| [prelude.ts:65](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L65) | ||
@@ -334,6 +328,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function. | | ||
@@ -344,3 +338,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
@@ -352,5 +346,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:155](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L155) | ||
| [prelude.ts:155](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L155) | ||
@@ -367,6 +361,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default value. | | ||
@@ -377,3 +371,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `U` | The value to return if the Option is `None`. | | ||
@@ -386,5 +380,5 @@ | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:163](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L163) | ||
| [prelude.ts:163](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L163) | ||
@@ -401,6 +395,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default function. | | ||
@@ -411,3 +405,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultFn` | () => `U` | A function that returns the default value. | | ||
@@ -420,5 +414,5 @@ | `fn` | (`value`) => `U` | A function that takes the contained value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:171](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L171) | ||
| [prelude.ts:171](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L171) | ||
@@ -435,6 +429,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `E` | The type of the error value in the `Err` variant of the resulting `Result`. | | ||
@@ -445,3 +439,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `error` | `E` | The error value to use if the Option is a `None`. | | ||
@@ -453,5 +447,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:113](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L113) | ||
| [prelude.ts:113](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L113) | ||
@@ -468,6 +462,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `E` | The type of the error value in the `Err` variant of the resulting `Result`. | | ||
@@ -478,3 +472,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `err` | () => `E` | A function that returns the error value. | | ||
@@ -486,5 +480,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:120](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L120) | ||
| [prelude.ts:120](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L120) | ||
@@ -505,3 +499,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The fallback `Option` to use if `this` is `None`. | | ||
@@ -515,5 +509,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:241](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L241) | ||
| [prelude.ts:241](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L241) | ||
@@ -534,3 +528,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | () => [`Option`](Option.md)\<`T`\> | A function that produces an `Option`. | | ||
@@ -544,5 +538,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:249](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L249) | ||
| [prelude.ts:249](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L249) | ||
@@ -559,6 +553,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the success value in the `Ok` variant of the `Result`. | | ||
@@ -570,3 +564,3 @@ | `E` | The type of the error value in the `Err` variant of the `Result`. | | ||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | ------ | ------ | | ||
| | `this` | [`Option`](Option.md)\<[`Result`](Result.md)\<`T`, `E`\>\> | | ||
@@ -582,5 +576,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:130](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L130) | ||
| [prelude.ts:130](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L130) | ||
@@ -605,5 +599,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:86](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L86) | ||
| [prelude.ts:86](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L86) | ||
@@ -623,3 +617,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `T` | The value to return if the Option is a `None`. | | ||
@@ -631,5 +625,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:92](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L92) | ||
| [prelude.ts:92](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L92) | ||
@@ -649,3 +643,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | () => `T` | A function that returns the default value. | | ||
@@ -657,5 +651,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:98](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L98) | ||
| [prelude.ts:98](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L98) | ||
@@ -674,6 +668,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the first value in the tuple. | | ||
@@ -685,3 +679,3 @@ | `U` | The type of the second value in the tuple. | | ||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | ------ | ------ | | ||
| | `this` | [`Option`](Option.md)\<[`T`, `U`]\> | | ||
@@ -695,5 +689,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:207](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L207) | ||
| [prelude.ts:207](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L207) | ||
@@ -714,3 +708,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`T`\> | The other `Option` to compare with. | | ||
@@ -724,5 +718,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:257](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L257) | ||
| [prelude.ts:257](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L257) | ||
@@ -741,6 +735,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -751,3 +745,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The other `Option` to zip with. | | ||
@@ -761,5 +755,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:185](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L185) | ||
| [prelude.ts:185](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L185) | ||
@@ -778,6 +772,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Option`. | | ||
@@ -789,3 +783,3 @@ | `R` | The return type of the combining function. | | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Option`](Option.md)\<`U`\> | The other `Option` to zip with. | | ||
@@ -800,4 +794,4 @@ | `fn` | (`value`, `otherValue`) => `R` | The function to combine the values from both `Options`. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:197](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L197) | ||
| [prelude.ts:197](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L197) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / Result | ||
| [happy-rusty](../README.md) / Result | ||
@@ -21,15 +21,9 @@ # Interface: Result\<T, E\> | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value contained in a successful `Result`. | | ||
| | `E` | The type of the error contained in an unsuccessful `Result`. | | ||
| ## Properties | ||
| | Property | Modifier | Type | Description | | ||
| | :------ | :------ | :------ | :------ | | ||
| | `[resultKindSymbol]` | `private` | `"Ok"` \| `"Err"` | Identify `Ok` or `Err`. | | ||
| ## Methods | ||
@@ -45,6 +39,6 @@ | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value in the other `Result`. | | ||
@@ -55,3 +49,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Result`](Result.md)\<`U`, `E`\> | The `Result` to return if `this` is `Ok`. | | ||
@@ -65,5 +59,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:518](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L518) | ||
| [prelude.ts:516](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L516) | ||
@@ -80,6 +74,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the function. | | ||
@@ -90,3 +84,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => [`Result`](Result.md)\<`U`, `E`\> | A function that takes the `Ok` value and returns a `Result`. | | ||
@@ -100,5 +94,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:534](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L534) | ||
| [prelude.ts:532](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L532) | ||
@@ -118,3 +112,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Result`](Result.md)\<`T`, `E`\> | The other `Result` to compare with. | | ||
@@ -128,5 +122,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:569](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L569) | ||
| [prelude.ts:567](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L567) | ||
@@ -149,5 +143,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:442](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L442) | ||
| [prelude.ts:440](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L440) | ||
@@ -167,3 +161,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `msg` | `string` | The error message to provide if the result is an `Err`. | | ||
@@ -179,5 +173,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:385](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L385) | ||
| [prelude.ts:383](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L383) | ||
@@ -197,3 +191,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `msg` | `string` | The error message to provide if the result is an `Ok`. | | ||
@@ -209,5 +203,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:414](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L414) | ||
| [prelude.ts:412](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L412) | ||
@@ -226,6 +220,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | | ||
| | :------ | | ||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | | ||
@@ -236,3 +230,3 @@ | ||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | ------ | ------ | | ||
| | `this` | [`Result`](Result.md)\<[`Result`](Result.md)\<`T`, `E`\>, `E`\> | | ||
@@ -244,5 +238,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:502](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L502) | ||
| [prelude.ts:500](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L500) | ||
@@ -263,3 +257,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `void` | A function to call with the `Ok` value. | | ||
@@ -273,5 +267,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:552](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L552) | ||
| [prelude.ts:550](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L550) | ||
@@ -292,3 +286,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`error`) => `void` | A function to call with the `Err` value. | | ||
@@ -302,5 +296,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:560](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L560) | ||
| [prelude.ts:558](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L558) | ||
@@ -321,5 +315,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:358](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L358) | ||
| [prelude.ts:356](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L356) | ||
@@ -339,3 +333,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`error`) => `boolean` | A function that takes the `Err` value and returns a boolean. | | ||
@@ -347,5 +341,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:370](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L370) | ||
| [prelude.ts:368](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L368) | ||
@@ -366,5 +360,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:353](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L353) | ||
| [prelude.ts:351](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L351) | ||
@@ -384,3 +378,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `predicate` | (`value`) => `boolean` | A function that takes the `Ok` value and returns a boolean. | | ||
@@ -392,5 +386,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:364](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L364) | ||
| [prelude.ts:362](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L362) | ||
@@ -408,6 +402,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function. | | ||
@@ -418,3 +412,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`value`) => `U` | A function that takes the `Ok` value and returns a new value. | | ||
@@ -426,5 +420,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:463](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L463) | ||
| [prelude.ts:461](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L461) | ||
@@ -442,6 +436,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `F` | The type of the error returned by the map function. | | ||
@@ -452,3 +446,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`error`) => `F` | A function that takes the `Err` value and returns a new error value. | | ||
@@ -460,5 +454,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:475](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L475) | ||
| [prelude.ts:473](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L473) | ||
@@ -475,6 +469,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default value. | | ||
@@ -485,3 +479,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `U` | The value to return if the result is `Err`. | | ||
@@ -494,5 +488,5 @@ | `fn` | (`value`) => `U` | A function that takes the `Ok` value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:487](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L487) | ||
| [prelude.ts:485](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L485) | ||
@@ -509,6 +503,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `U` | The type of the value returned by the map function or the default function. | | ||
@@ -519,3 +513,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultFn` | (`error`) => `U` | A function that returns the default value. | | ||
@@ -528,5 +522,5 @@ | `fn` | (`value`) => `U` | A function that takes the `Ok` value and returns a new value. | | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:495](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L495) | ||
| [prelude.ts:493](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L493) | ||
@@ -549,5 +543,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:435](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L435) | ||
| [prelude.ts:433](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L433) | ||
@@ -564,6 +558,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `F` | The type of the error in the other `Result`. | | ||
@@ -574,3 +568,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `other` | [`Result`](Result.md)\<`T`, `F`\> | The `Result` to return if `this` is `Err`. | | ||
@@ -584,5 +578,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:526](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L526) | ||
| [prelude.ts:524](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L524) | ||
@@ -599,6 +593,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `F` | The type of the error returned by the function. | | ||
@@ -609,3 +603,3 @@ | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`error`) => [`Result`](Result.md)\<`T`, `F`\> | A function that takes the `Err` value and returns a `Result`. | | ||
@@ -619,5 +613,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:542](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L542) | ||
| [prelude.ts:540](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L540) | ||
@@ -634,6 +628,6 @@ *** | ||
| #### Type parameters | ||
| #### Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the success value in the `Ok` variant of the `Option`. | | ||
@@ -644,3 +638,3 @@ | ||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | ------ | ------ | | ||
| | `this` | [`Result`](Result.md)\<[`Option`](Option.md)\<`T`\>, `E`\> | | ||
@@ -656,5 +650,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:451](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L451) | ||
| [prelude.ts:449](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L449) | ||
@@ -679,5 +673,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:391](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L391) | ||
| [prelude.ts:389](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L389) | ||
@@ -702,5 +696,5 @@ *** | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:420](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L420) | ||
| [prelude.ts:418](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L418) | ||
@@ -720,3 +714,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `defaultValue` | `T` | The value to return if the result is an `Err`. | | ||
@@ -728,5 +722,5 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:397](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L397) | ||
| [prelude.ts:395](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L395) | ||
@@ -746,3 +740,3 @@ *** | ||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | ------ | ------ | ------ | | ||
| | `fn` | (`error`) => `T` | A function that takes the `Err` value and returns an `Ok` value. | | ||
@@ -754,4 +748,4 @@ | ||
| #### Source | ||
| #### Defined in | ||
| [enum/prelude.ts:403](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L403) | ||
| [prelude.ts:401](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L401) |
@@ -1,8 +0,8 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / AsyncIOResult | ||
| [happy-rusty](../README.md) / AsyncIOResult | ||
| # Type alias: AsyncIOResult\<T\> | ||
| # Type Alias: AsyncIOResult\<T\> | ||
@@ -16,10 +16,10 @@ ```ts | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value that is produced by a successful I/O operation. | | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:609](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L609) | ||
| [prelude.ts:607](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L607) |
@@ -1,8 +0,8 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / AsyncOption | ||
| [happy-rusty](../README.md) / AsyncOption | ||
| # Type alias: AsyncOption\<T\> | ||
| # Type Alias: AsyncOption\<T\> | ||
@@ -16,10 +16,10 @@ ```ts | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value that may be contained within the `Option`. | | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:584](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L584) | ||
| [prelude.ts:582](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L582) |
@@ -1,8 +0,8 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / AsyncResult | ||
| [happy-rusty](../README.md) / AsyncResult | ||
| # Type alias: AsyncResult\<T, E\> | ||
| # Type Alias: AsyncResult\<T, E\> | ||
@@ -16,11 +16,11 @@ ```ts | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value that is produced by a successful operation. | | ||
| | `E` | The type of the error that may be produced by a failed operation. | | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:593](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L593) | ||
| [prelude.ts:591](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L591) |
@@ -1,8 +0,8 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / IOResult | ||
| [happy-rusty](../README.md) / IOResult | ||
| # Type alias: IOResult\<T\> | ||
| # Type Alias: IOResult\<T\> | ||
@@ -16,10 +16,10 @@ ```ts | ||
| ## Type parameters | ||
| ## Type Parameters | ||
| | Type parameter | Description | | ||
| | :------ | :------ | | ||
| | Type Parameter | Description | | ||
| | ------ | ------ | | ||
| | `T` | The type of the value that is produced by a successful operation. | | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:601](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L601) | ||
| [prelude.ts:599](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L599) |
@@ -1,6 +0,6 @@ | ||
| [**happy-rusty**](../index.md) • **Docs** | ||
| [**happy-rusty**](../README.md) • **Docs** | ||
| *** | ||
| [happy-rusty](../index.md) / None | ||
| [happy-rusty](../README.md) / None | ||
@@ -16,4 +16,4 @@ # Variable: None | ||
| ## Source | ||
| ## Defined in | ||
| [enum/prelude.ts:288](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L288) | ||
| [prelude.ts:286](https://github.com/JiangJie/happy-rusty/blob/82bfb94138be23b97750c830432d7e013c0e5b80/src/enum/prelude.ts#L286) |
@@ -6,3 +6,3 @@ { | ||
| "license": "GPL-3.0", | ||
| "version": "1.1.0", | ||
| "version": "1.1.1", | ||
| "type": "module", | ||
@@ -51,13 +51,13 @@ "source": "src/mod.ts", | ||
| "devDependencies": { | ||
| "@typescript-eslint/eslint-plugin": "^7.12.0", | ||
| "@typescript-eslint/parser": "^7.12.0", | ||
| "@typescript-eslint/eslint-plugin": "^7.16.0", | ||
| "@typescript-eslint/parser": "^7.16.0", | ||
| "eslint": "^8.57.0", | ||
| "rollup": "^4.18.0", | ||
| "rollup": "^4.18.1", | ||
| "rollup-plugin-dts": "^6.1.1", | ||
| "rollup-plugin-esbuild": "^6.1.1", | ||
| "typedoc": "^0.25.13", | ||
| "typedoc-plugin-markdown": "^4.0.3", | ||
| "typescript": "^5.4.5" | ||
| "typedoc": "^0.26.4", | ||
| "typedoc-plugin-markdown": "^4.2.1", | ||
| "typescript": "^5.5.3" | ||
| }, | ||
| "packageManager": "pnpm@9.2.0" | ||
| "packageManager": "pnpm@9.5.0" | ||
| } |
@@ -61,2 +61,2 @@ # 在 JavaScript 中使用 Rust 特性 | ||
| ## [文档](docs/index.md) | ||
| ## [文档](docs/README.md) |
@@ -67,2 +67,2 @@ # Use Rust features in JavaScript happily | ||
| ## [Docs](docs/index.md) | ||
| ## [Docs](docs/README.md) |
@@ -285,4 +285,2 @@ /* eslint-disable @typescript-eslint/no-unused-vars */ | ||
| * The type parameter is set to `never` because `None` does not hold a value. | ||
| * | ||
| * @extends {Option<never>} Extends the generic `Option` type with `never` to denote no value. | ||
| */ | ||
@@ -289,0 +287,0 @@ export interface None extends Option<never> { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Number of medium supply chain risk alerts
0
-100%Worsened metrics
- Total package byte prevSize
264148
-0.37%- Lines of code
1832
-0.22%No dependency changes