happy-rusty 1.1.0 → 1.1.2

package/docs/type-aliases/AsyncIOResult.md

@@ -1,10 +1,10 @@
-[**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\>
 
 ```ts
 type AsyncIOResult<T>: Promise<IOResult<T>>;
@@ -13,12 +13,12 @@ type AsyncIOResult<T>: Promise<IOResult<T>>;
 Represents an asynchronous I/O operation that yields a `Result<T, Error>`.
 This is a promise that resolves to `Ok(T)` if the I/O operation was successful, or `Err(Error)` if there was an error.
 
-## 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:628](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L628)

package/docs/type-aliases/AsyncOption.md

@@ -1,10 +1,10 @@
-[**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\>
 
 ```ts
 type AsyncOption<T>: Promise<Option<T>>;
@@ -13,12 +13,12 @@ type AsyncOption<T>: Promise<Option<T>>;
 Represents an asynchronous operation that yields an `Option<T>`.
 This is a promise that resolves to either `Some(T)` if the value is present, or `None` if the value is absent.
 
-## 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:603](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L603)

package/docs/type-aliases/AsyncResult.md

@@ -1,10 +1,10 @@
-[**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\>
 
 ```ts
 type AsyncResult<T, E>: Promise<Result<T, E>>;
@@ -13,13 +13,13 @@ type AsyncResult<T, E>: Promise<Result<T, E>>;
 Represents an asynchronous operation that yields a `Result<T, E>`.
 This is a promise that resolves to `Ok(T)` if the operation was successful, or `Err(E)` if there was an error.
 
-## 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:612](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L612)

package/docs/type-aliases/IOResult.md

@@ -1,10 +1,10 @@
-[**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\>
 
 ```ts
 type IOResult<T>: Result<T, Error>;
@@ -13,12 +13,12 @@ type IOResult<T>: Result<T, Error>;
 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.
 
-## 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:620](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L620)

package/docs/variables/None.md

@@ -1,8 +1,8 @@
-[**happy-rusty**](../index.md) • **Docs**
+[**happy-rusty**](../README.md) • **Docs**
 
 ***
 
-[happy-rusty](../index.md) / None
+[happy-rusty](../README.md) / None
 
 # Variable: None
 
@@ -13,6 +13,6 @@ None: None;
 A constant representing the `None` case of an `Option`, indicating the absence of a value.
 This constant is frozen to ensure it is immutable and cannot be altered, preserving the integrity of `None` throughout the application.
 
-## 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/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L286)

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.1.0",
+  "version": "1.1.2",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -47,15 +47,15 @@
     "Err"
   ],
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.12.0",
-    "@typescript-eslint/parser": "^7.12.0",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
     "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"
 }

package/src/enum/prelude.ts

@@ -282,8 +282,6 @@ export interface Option<T> {
 /**
  * Represents the absence of a value, as a specialized `Option` type.
  * 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.
  */
 export interface None extends Option<never> {
     /**
@@ -569,6 +567,27 @@ export interface Result<T, E> {
     eq(other: Result<T, E>): boolean;
 
     // #endregion
+
+    /**
+     * Transforms the current Result into a new Result where the type of the error result is replaced with a new type `F`.
+     * The type of the success result remains unchanged.
+     * Just same as `result as unknown as Result<T, F>`.
+     *
+     * @typeParam F - The new type for the error result.
+     * @returns `this` but the error result type is `F`.
+     */
+    asOk<F>(): Result<T, F>;
+
+    /**
+     * Transforms the current Result into a new Result where the type of the success result is replaced with a new type `U`.
+     * The type of the error result remains unchanged.
+     * Useful where you need to return an Error chained to another type.
+     * Just same as `result as unknown as Result<U, E>`.
+     *
+     * @typeParam U - The new type for the success result.
+     * @returns `this` but the success result type is `U`.
+     */
+    asErr<U>(): Result<U, E>;
 }
 
 /**
@@ -830,6 +849,13 @@ export function Ok<T, E>(value: T): Result<T, E> {
             assertResult(other);
             return other.isOk() && other.unwrap() === value;
         },
+
+        asOk<F>(): Result<T, F> {
+            return ok as unknown as Result<T, F>;
+        },
+        asErr(): never {
+            throw new TypeError('Called `Result::asErr()` on an `Ok` value');
+        },
     } as const;
 
     return ok;
@@ -901,6 +927,13 @@ export function Err<T, E>(error: E): Result<T, E> {
             assertResult(other);
             return other.isErr() && other.unwrapErr() === error;
         },
+
+        asOk(): never {
+            throw new TypeError('Called `Result::asOk()` on an `Err` value');
+        },
+        asErr<U>(): Result<U, E> {
+            return err as unknown as Result<U, E>;
+        },
     } as const;
 
     return err;