happy-rusty 1.3.1 → 1.4.0

package/docs/interfaces/Result.md

@@ -29,7 +29,7 @@ pub enum Result<T, E> {
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| `[toStringTag]` | `"Result"` | [object Result]. | [core.ts:304](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L304) |
+| `[toStringTag]` | `"Result"` | [object Result]. | [core.ts:304](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L304) |
 
 ## Methods
 
@@ -61,7 +61,7 @@ The passed `Result` if `this` is `Ok`, otherwise returns `this` (which is `Err`)
 
 #### Defined in
 
-[core.ts:489](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L489)
+[core.ts:489](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L489)
 
 ***
 
@@ -93,7 +93,7 @@ The result of `fn` if `this` is `Ok`, otherwise `this` as `Err`.
 
 #### Defined in
 
-[core.ts:505](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L505)
+[core.ts:505](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L505)
 
 ***
 
@@ -122,7 +122,7 @@ Just same as `result as unknown as Result<U, E>`.
 
 #### Defined in
 
-[core.ts:563](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L563)
+[core.ts:563](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L563)
 
 ***
 
@@ -150,7 +150,7 @@ Just same as `result as unknown as Result<T, F>`.
 
 #### Defined in
 
-[core.ts:552](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L552)
+[core.ts:552](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L552)
 
 ***
 
@@ -176,7 +176,7 @@ Tests whether `this` and `other` are both `Ok` containing equal values, or both
 
 #### Defined in
 
-[core.ts:540](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L540)
+[core.ts:540](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L540)
 
 ***
 
@@ -196,7 +196,7 @@ If the result is `Ok`, returns `None`.
 
 #### Defined in
 
-[core.ts:413](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L413)
+[core.ts:413](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L413)
 
 ***
 
@@ -224,7 +224,7 @@ Throws an error with the provided message if the result is an `Err`.
 
 #### Defined in
 
-[core.ts:356](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L356)
+[core.ts:356](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L356)
 
 ***
 
@@ -252,7 +252,7 @@ Throws an error with the provided message if the result is an `Ok`.
 
 #### Defined in
 
-[core.ts:385](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L385)
+[core.ts:385](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L385)
 
 ***
 
@@ -284,7 +284,7 @@ If the result is `Ok(Err(E))` or `Err(E)`, returns `Err(E)`.
 
 #### Defined in
 
-[core.ts:473](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L473)
+[core.ts:473](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L473)
 
 ***
 
@@ -311,7 +311,7 @@ Does not modify the `Result`.
 
 #### Defined in
 
-[core.ts:523](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L523)
+[core.ts:523](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L523)
 
 ***
 
@@ -338,7 +338,7 @@ Does not modify the `Result`.
 
 #### Defined in
 
-[core.ts:531](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L531)
+[core.ts:531](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L531)
 
 ***
 
@@ -356,7 +356,7 @@ Returns `true` if the result is `Err`.
 
 #### Defined in
 
-[core.ts:329](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L329)
+[core.ts:329](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L329)
 
 ***
 
@@ -380,7 +380,7 @@ Returns `true` if the result is `Err` and the provided predicate returns `true`
 
 #### Defined in
 
-[core.ts:341](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L341)
+[core.ts:341](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L341)
 
 ***
 
@@ -398,7 +398,7 @@ Returns `true` if the result is `Ok`.
 
 #### Defined in
 
-[core.ts:324](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L324)
+[core.ts:324](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L324)
 
 ***
 
@@ -422,7 +422,7 @@ Returns `true` if the result is `Ok` and the provided predicate returns `true` f
 
 #### Defined in
 
-[core.ts:335](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L335)
+[core.ts:335](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L335)
 
 ***
 
@@ -453,7 +453,7 @@ leaving an `Err` value untouched.
 
 #### Defined in
 
-[core.ts:434](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L434)
+[core.ts:434](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L434)
 
 ***
 
@@ -484,7 +484,7 @@ leaving an `Ok` value untouched.
 
 #### Defined in
 
-[core.ts:446](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L446)
+[core.ts:446](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L446)
 
 ***
 
@@ -515,7 +515,7 @@ Maps a `Result<T, E>` to `U` by applying a function to the contained `Ok` value
 
 #### Defined in
 
-[core.ts:458](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L458)
+[core.ts:458](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L458)
 
 ***
 
@@ -546,7 +546,7 @@ Maps a `Result<T, E>` to `U` by applying a function to the contained `Ok` value
 
 #### Defined in
 
-[core.ts:466](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L466)
+[core.ts:466](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L466)
 
 ***
 
@@ -566,7 +566,7 @@ If the result is `Err`, returns `None`.
 
 #### Defined in
 
-[core.ts:406](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L406)
+[core.ts:406](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L406)
 
 ***
 
@@ -598,7 +598,7 @@ Returns `this` if it is `Ok`, otherwise returns the passed `Result`.
 
 #### Defined in
 
-[core.ts:497](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L497)
+[core.ts:497](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L497)
 
 ***
 
@@ -630,7 +630,7 @@ The result of `fn` if `this` is `Err`, otherwise `this` as `Ok`.
 
 #### Defined in
 
-[core.ts:513](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L513)
+[core.ts:513](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L513)
 
 ***
 
@@ -648,7 +648,7 @@ Custom `toString` implementation that uses the `Result`'s contained value.
 
 #### Defined in
 
-[core.ts:568](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L568)
+[core.ts:568](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L568)
 
 ***
 
@@ -682,7 +682,7 @@ Transposes a `Result` of an `Option` into an `Option` of a `Result`.
 
 #### Defined in
 
-[core.ts:422](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L422)
+[core.ts:422](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L422)
 
 ***
 
@@ -704,7 +704,7 @@ Throws an error if the result is an `Err`.
 
 #### Defined in
 
-[core.ts:362](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L362)
+[core.ts:362](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L362)
 
 ***
 
@@ -726,7 +726,7 @@ Throws an error if the result is an `Ok`.
 
 #### Defined in
 
-[core.ts:391](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L391)
+[core.ts:391](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L391)
 
 ***
 
@@ -750,7 +750,7 @@ Returns the contained `Ok` value or a provided default.
 
 #### Defined in
 
-[core.ts:368](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L368)
+[core.ts:368](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L368)
 
 ***
 
@@ -774,4 +774,4 @@ Returns the contained `Ok` value or computes it from a closure if the result is
 
 #### Defined in
 
-[core.ts:374](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L374)
+[core.ts:374](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/core.ts#L374)

package/docs/type-aliases/AsyncIOResult.md

@@ -21,4 +21,4 @@ This is a promise that resolves to `Ok(T)` if the I/O operation was successful,
 
 ## Defined in
 
-[defines.ts:38](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/defines.ts#L38)
+[defines.ts:52](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L52)

package/docs/type-aliases/AsyncOption.md

@@ -21,4 +21,4 @@ This is a promise that resolves to either `Some(T)` if the value is present, or
 
 ## Defined in
 
-[defines.ts:13](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/defines.ts#L13)
+[defines.ts:13](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L13)

package/docs/type-aliases/AsyncResult.md

@@ -22,4 +22,4 @@ This is a promise that resolves to `Ok(T)` if the operation was successful, or `
 
 ## Defined in
 
-[defines.ts:22](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/defines.ts#L22)
+[defines.ts:22](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L22)

package/docs/type-aliases/AsyncVoidIOResult.md

@@ -0,0 +1,17 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / AsyncVoidIOResult
+
+# Type Alias: AsyncVoidIOResult
+
+```ts
+type AsyncVoidIOResult: AsyncIOResult<void>;
+```
+
+`VoidIOResult` wrapped by `Promise`.
+
+## Defined in
+
+[defines.ts:62](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L62)

package/docs/type-aliases/AsyncVoidResult.md

@@ -0,0 +1,23 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / AsyncVoidResult
+
+# Type Alias: AsyncVoidResult\<E\>
+
+```ts
+type AsyncVoidResult<E>: Promise<VoidResult<E>>;
+```
+
+`VoidResult<E>` wrapped by `Promise`.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `E` | The type of the error that may be produced by a failed operation. |
+
+## Defined in
+
+[defines.ts:36](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L36)

package/docs/type-aliases/IOResult.md

@@ -21,4 +21,4 @@ This is a result that is either `Ok(T)` if the operation was successful, or `Err
 
 ## Defined in
 
-[defines.ts:30](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/defines.ts#L30)
+[defines.ts:44](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L44)

package/docs/type-aliases/VoidIOResult.md

@@ -0,0 +1,17 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / VoidIOResult
+
+# Type Alias: VoidIOResult
+
+```ts
+type VoidIOResult: IOResult<void>;
+```
+
+Similar to Rust's `Result<(), Error>`.
+
+## Defined in
+
+[defines.ts:57](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L57)

package/docs/type-aliases/VoidResult.md

@@ -0,0 +1,23 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / VoidResult
+
+# Type Alias: VoidResult\<E\>
+
+```ts
+type VoidResult<E>: Result<void, E>;
+```
+
+Similar to Rust's `Result<(), E>`.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `E` | The type of the error that may be produced by a failed operation. |
+
+## Defined in
+
+[defines.ts:29](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L29)

package/docs/variables/None.md

@@ -15,4 +15,4 @@ This constant is frozen to ensure it is immutable and cannot be altered, preserv
 
 ## Defined in
 
-[prelude.ts:10](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L10)
+[prelude.ts:10](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/prelude.ts#L10)

package/docs/variables/RESULT_FALSE.md

@@ -15,4 +15,4 @@ Can be used anywhere due to immutability.
 
 ## Defined in
 
-[constants.ts:19](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/constants.ts#L19)
+[constants.ts:19](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L19)

package/docs/variables/RESULT_TRUE.md

@@ -15,4 +15,4 @@ Can be used anywhere due to immutability.
 
 ## Defined in
 
-[constants.ts:13](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/constants.ts#L13)
+[constants.ts:13](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L13)

package/docs/variables/RESULT_VOID.md

@@ -0,0 +1,17 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / RESULT\_VOID
+
+# Variable: RESULT\_VOID
+
+```ts
+const RESULT_VOID: Result<void, any>;
+```
+
+Result constant for `void` or `()`.
+
+## Defined in
+
+[constants.ts:30](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L30)

package/docs/variables/RESULT_ZERO.md

@@ -15,4 +15,4 @@ Can be used anywhere due to immutability.
 
 ## Defined in
 
-[constants.ts:25](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/constants.ts#L25)
+[constants.ts:25](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L25)

package/package.json

@@ -3,7 +3,7 @@
   "description": "Porting some excellent design implementations from Rust to JavaScript.",
   "author": "jiang115jie@gmail.com",
   "license": "GPL-3.0",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -30,6 +30,7 @@
     "test:html": "deno test --coverage && deno coverage coverage && deno coverage coverage --html",
     "predocs": "pnpm dlx rimraf docs",
     "docs": "pnpm exec typedoc",
+    "eg": "deno run -A examples/main.ts",
     "prepublishOnly": "pnpm run build"
   },
   "repository": {

package/src/enum/constants.ts

@@ -22,4 +22,9 @@ export const RESULT_FALSE: Result<boolean, any> = Ok(false);
  * Result constant for `0`.
  * Can be used anywhere due to immutability.
  */
-export const RESULT_ZERO: Result<number, any> = Ok(0);
+export const RESULT_ZERO: Result<number, any> = Ok(0);
+
+/**
+ * Result constant for `void` or `()`.
+ */
+export const RESULT_VOID: Result<void, any> = Ok();

package/src/enum/defines.ts

@@ -21,6 +21,20 @@ export type AsyncOption<T> = Promise<Option<T>>;
  */
 export type AsyncResult<T, E> = Promise<Result<T, E>>;
 
+/**
+ * Similar to Rust's `Result<(), E>`.
+ *
+ * @typeParam E - The type of the error that may be produced by a failed operation.
+ */
+export type VoidResult<E> = Result<void, E>;
+
+/**
+ * `VoidResult<E>` wrapped by `Promise`.
+ *
+ * @typeParam E - The type of the error that may be produced by a failed operation.
+ */
+export type AsyncVoidResult<E> = Promise<VoidResult<E>>;
+
 /**
  * Represents a synchronous operation that yields a `Result<T, Error>`.
  * This is a result that is either `Ok(T)` if the operation was successful, or `Err(Error)` if there was an error.
@@ -35,4 +49,14 @@ export type IOResult<T> = Result<T, Error>;
  *
  * @typeParam T - The type of the value that is produced by a successful I/O operation.
  */
-export type AsyncIOResult<T> = AsyncResult<T, Error>;
+export type AsyncIOResult<T> = AsyncResult<T, Error>;
+
+/**
+ * Similar to Rust's `Result<(), Error>`.
+ */
+export type VoidIOResult = IOResult<void>;
+
+/**
+ * `VoidIOResult` wrapped by `Promise`.
+ */
+export type AsyncVoidIOResult = AsyncIOResult<void>;

package/src/enum/extensions.ts

@@ -13,12 +13,12 @@ import { Err, Ok } from './prelude.ts';
  * @example
  * ```ts
  * async function example() {
- *   const result = await promiseToAsyncResult(fetchData());
- *   if (result.isOk()) {
- *     console.log('Data:', result.unwrap());
- *   } else {
- *     console.error('Error:', result.unwrapErr());
- *   }
+ *     const result = await promiseToAsyncResult(fetchData());
+ *     result.inspect(x => {
+ *         console.log('Data:', x);
+ *     }).inspectErr(err => {
+ *         console.error('Error:', err);
+ *     });
  * }
  * ```
  */

package/src/enum/mod.ts

@@ -2,5 +2,5 @@ export * from './constants.ts';
 export * from './core.ts';
 export * from './defines.ts';
 export * from './extensions.ts';
-export * from './helpers.ts';
 export * from './prelude.ts';
+export * from './utils.ts';

package/src/enum/prelude.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import type { Option, Result } from './core.ts';
-import { isOption, isResult } from './helpers.ts';
 import { OptionKindSymbol, ResultKindSymbol } from './symbols.ts';
+import { isOption, isResult } from './utils.ts';
 
 /**
  * Represents the absence of a value, as a specialized `Option` type.
@@ -283,7 +283,12 @@ export const None = Object.freeze<None>({
  * }
  * ```
  */
-export function Ok<T, E>(value: T): Result<T, E> {
+export function Ok<T, E>(value: T): Result<T, E>;
+/**
+ * Because javascript does not have a `()` type, use `void` instead.
+ */
+export function Ok<E>(): Result<void, E>;
+export function Ok<T, E>(value?: T): Result<T, E> {
     const ok: Result<T, E> = {
         [Symbol.toStringTag]: 'Result',
         [ResultKindSymbol]: 'Ok',
@@ -295,23 +300,23 @@ export function Ok<T, E>(value: T): Result<T, E> {
             return false;
         },
         isOkAnd(predicate: (value: T) => boolean): boolean {
-            return predicate(value);
+            return predicate(value as T);
         },
         isErrAnd(_predicate: (error: E) => boolean): false {
             return false;
         },
 
         expect(_msg: string): T {
-            return value;
+            return value as T;
         },
         unwrap(): T {
-            return value;
+            return value as T;
         },
         unwrapOr(_defaultValue: T): T {
-            return value;
+            return value as T;
         },
         unwrapOrElse(_fn: (error: E) => T): T {
-            return value;
+            return value as T;
         },
 
         expectErr(msg: string): E {
@@ -322,7 +327,7 @@ export function Ok<T, E>(value: T): Result<T, E> {
         },
 
         ok(): Option<T> {
-            return Some(value);
+            return Some(value as T);
         },
         err(): None {
             return None;
@@ -334,16 +339,16 @@ export function Ok<T, E>(value: T): Result<T, E> {
         },
 
         map<U>(fn: (value: T) => U): Result<U, E> {
-            return Ok(fn(value));
+            return Ok(fn(value as T));
         },
         mapErr<F>(_fn: (error: E) => F): Result<T, F> {
-            return Ok(value);
+            return Ok(value as T);
         },
         mapOr<U>(_defaultValue: U, fn: (value: T) => U): U {
-            return fn(value);
+            return fn(value as T);
         },
         mapOrElse<U>(_defaultFn: (error: E) => U, fn: (value: T) => U): U {
-            return fn(value);
+            return fn(value as T);
         },
         flatten<T>(): Result<T, E> {
             const r = value as Result<T, E>;
@@ -359,14 +364,14 @@ export function Ok<T, E>(value: T): Result<T, E> {
             return ok as unknown as Result<T, F>;
         },
         andThen<U>(fn: (value: T) => Result<U, E>): Result<U, E> {
-            return fn(value);
+            return fn(value as T);
         },
         orElse<F>(_fn: (error: E) => Result<T, F>): Result<T, F> {
             return ok as unknown as Result<T, F>;
         },
 
         inspect(fn: (value: T) => void): Result<T, E> {
-            fn(value);
+            fn(value as T);
             return ok;
         },
         inspectErr(_fn: (error: E) => void): Result<T, E> {