happy-rusty 1.1.2 → 1.3.0

package/docs/interfaces/Result.md

@@ -25,6 +25,12 @@ pub enum Result<T, E> {
 | `T` | The type of the value contained in a successful `Result`. |
 | `E` | The type of the error contained in an unsuccessful `Result`. |
 
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `[toStringTag]` | `"Result"` | [object Result]. | [core.ts:304](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L304) |
+
 ## Methods
 
 ### and()
@@ -55,7 +61,7 @@ The passed `Result` if `this` is `Ok`, otherwise returns `this` (which is `Err`)
 
 #### Defined in
 
-[prelude.ts:516](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L516)
+[core.ts:489](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L489)
 
 ***
 
@@ -87,7 +93,7 @@ The result of `fn` if `this` is `Ok`, otherwise `this` as `Err`.
 
 #### Defined in
 
-[prelude.ts:532](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L532)
+[core.ts:505](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L505)
 
 ***
 
@@ -116,7 +122,7 @@ Just same as `result as unknown as Result<U, E>`.
 
 #### Defined in
 
-[prelude.ts:590](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L590)
+[core.ts:563](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L563)
 
 ***
 
@@ -144,7 +150,7 @@ Just same as `result as unknown as Result<T, F>`.
 
 #### Defined in
 
-[prelude.ts:579](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L579)
+[core.ts:552](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L552)
 
 ***
 
@@ -170,7 +176,7 @@ Tests whether `this` and `other` are both `Ok` containing equal values, or both
 
 #### Defined in
 
-[prelude.ts:567](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L567)
+[core.ts:540](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L540)
 
 ***
 
@@ -190,7 +196,7 @@ If the result is `Ok`, returns `None`.
 
 #### Defined in
 
-[prelude.ts:440](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L440)
+[core.ts:413](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L413)
 
 ***
 
@@ -218,7 +224,7 @@ Throws an error with the provided message if the result is an `Err`.
 
 #### Defined in
 
-[prelude.ts:383](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L383)
+[core.ts:356](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L356)
 
 ***
 
@@ -246,7 +252,7 @@ Throws an error with the provided message if the result is an `Ok`.
 
 #### Defined in
 
-[prelude.ts:412](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L412)
+[core.ts:385](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L385)
 
 ***
 
@@ -278,7 +284,7 @@ If the result is `Ok(Err(E))` or `Err(E)`, returns `Err(E)`.
 
 #### Defined in
 
-[prelude.ts:500](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L500)
+[core.ts:473](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L473)
 
 ***
 
@@ -305,7 +311,7 @@ Does not modify the `Result`.
 
 #### Defined in
 
-[prelude.ts:550](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L550)
+[core.ts:523](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L523)
 
 ***
 
@@ -332,7 +338,7 @@ Does not modify the `Result`.
 
 #### Defined in
 
-[prelude.ts:558](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L558)
+[core.ts:531](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L531)
 
 ***
 
@@ -350,7 +356,7 @@ Returns `true` if the result is `Err`.
 
 #### Defined in
 
-[prelude.ts:356](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L356)
+[core.ts:329](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L329)
 
 ***
 
@@ -374,7 +380,7 @@ Returns `true` if the result is `Err` and the provided predicate returns `true`
 
 #### Defined in
 
-[prelude.ts:368](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L368)
+[core.ts:341](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L341)
 
 ***
 
@@ -392,7 +398,7 @@ Returns `true` if the result is `Ok`.
 
 #### Defined in
 
-[prelude.ts:351](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L351)
+[core.ts:324](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L324)
 
 ***
 
@@ -416,7 +422,7 @@ Returns `true` if the result is `Ok` and the provided predicate returns `true` f
 
 #### Defined in
 
-[prelude.ts:362](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L362)
+[core.ts:335](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L335)
 
 ***
 
@@ -447,7 +453,7 @@ leaving an `Err` value untouched.
 
 #### Defined in
 
-[prelude.ts:461](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L461)
+[core.ts:434](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L434)
 
 ***
 
@@ -478,7 +484,7 @@ leaving an `Ok` value untouched.
 
 #### Defined in
 
-[prelude.ts:473](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L473)
+[core.ts:446](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L446)
 
 ***
 
@@ -509,7 +515,7 @@ Maps a `Result<T, E>` to `U` by applying a function to the contained `Ok` value
 
 #### Defined in
 
-[prelude.ts:485](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L485)
+[core.ts:458](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L458)
 
 ***
 
@@ -540,7 +546,7 @@ Maps a `Result<T, E>` to `U` by applying a function to the contained `Ok` value
 
 #### Defined in
 
-[prelude.ts:493](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L493)
+[core.ts:466](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L466)
 
 ***
 
@@ -560,7 +566,7 @@ If the result is `Err`, returns `None`.
 
 #### Defined in
 
-[prelude.ts:433](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L433)
+[core.ts:406](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L406)
 
 ***
 
@@ -592,7 +598,7 @@ Returns `this` if it is `Ok`, otherwise returns the passed `Result`.
 
 #### Defined in
 
-[prelude.ts:524](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L524)
+[core.ts:497](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L497)
 
 ***
 
@@ -624,7 +630,25 @@ The result of `fn` if `this` is `Err`, otherwise `this` as `Ok`.
 
 #### Defined in
 
-[prelude.ts:540](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L540)
+[core.ts:513](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L513)
+
+***
+
+### toString()
+
+```ts
+toString(): string
+```
+
+Custom `toString` implementation that uses the `Result`'s contained value.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[core.ts:568](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L568)
 
 ***
 
@@ -658,7 +682,7 @@ Transposes a `Result` of an `Option` into an `Option` of a `Result`.
 
 #### Defined in
 
-[prelude.ts:449](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L449)
+[core.ts:422](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L422)
 
 ***
 
@@ -680,7 +704,7 @@ Throws an error if the result is an `Err`.
 
 #### Defined in
 
-[prelude.ts:389](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L389)
+[core.ts:362](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L362)
 
 ***
 
@@ -702,7 +726,7 @@ Throws an error if the result is an `Ok`.
 
 #### Defined in
 
-[prelude.ts:418](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L418)
+[core.ts:391](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L391)
 
 ***
 
@@ -726,7 +750,7 @@ Returns the contained `Ok` value or a provided default.
 
 #### Defined in
 
-[prelude.ts:395](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L395)
+[core.ts:368](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L368)
 
 ***
 
@@ -750,4 +774,4 @@ Returns the contained `Ok` value or computes it from a closure if the result is
 
 #### Defined in
 
-[prelude.ts:401](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L401)
+[core.ts:374](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L374)

package/docs/type-aliases/AsyncIOResult.md

@@ -7,7 +7,7 @@
 # Type Alias: AsyncIOResult\<T\>
 
 ```ts
-type AsyncIOResult<T>: Promise<IOResult<T>>;
+type AsyncIOResult<T>: AsyncResult<T, Error>;
 ```
 
 Represents an asynchronous I/O operation that yields a `Result<T, Error>`.
@@ -21,4 +21,4 @@ This is a promise that resolves to `Ok(T)` if the I/O operation was successful,
 
 ## Defined in
 
-[prelude.ts:628](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L628)
+[defines.ts:38](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/defines.ts#L38)

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
 
-[prelude.ts:603](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L603)
+[defines.ts:13](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/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
 
-[prelude.ts:612](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L612)
+[defines.ts:22](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/defines.ts#L22)

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
 
-[prelude.ts:620](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L620)
+[defines.ts:30](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/defines.ts#L30)

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:286](https://github.com/JiangJie/happy-rusty/blob/7218a182717eb5dbba4bfaf783977bc5e378815a/src/enum/prelude.ts#L286)
+[prelude.ts:10](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L10)

package/docs/variables/RESULT_FALSE.md

@@ -0,0 +1,18 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / RESULT\_FALSE
+
+# Variable: RESULT\_FALSE
+
+```ts
+const RESULT_FALSE: Result<boolean, any>;
+```
+
+Result constant for `false`.
+Can be used anywhere due to immutability.
+
+## Defined in
+
+[constants.ts:19](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/constants.ts#L19)

package/docs/variables/RESULT_TRUE.md

@@ -0,0 +1,18 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / RESULT\_TRUE
+
+# Variable: RESULT\_TRUE
+
+```ts
+const RESULT_TRUE: Result<boolean, any>;
+```
+
+Result constant for `true`.
+Can be used anywhere due to immutability.
+
+## Defined in
+
+[constants.ts:13](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/constants.ts#L13)

package/docs/variables/RESULT_ZERO.md

@@ -0,0 +1,18 @@
+[**happy-rusty**](../README.md) • **Docs**
+
+***
+
+[happy-rusty](../README.md) / RESULT\_ZERO
+
+# Variable: RESULT\_ZERO
+
+```ts
+const RESULT_ZERO: Result<number, any>;
+```
+
+Result constant for `0`.
+Can be used anywhere due to immutability.
+
+## Defined in
+
+[constants.ts:25](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/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.1.2",
+  "version": "1.3.0",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -21,7 +21,7 @@
   "sideEffects": false,
   "scripts": {
     "check": "pnpm exec tsc --noEmit",
-    "lint": "pnpm exec eslint src/",
+    "lint": "pnpm exec eslint .",
     "prebuild": "pnpm dlx rimraf dist && pnpm run check && pnpm run lint",
     "build": "pnpm exec rollup --config rollup.config.mjs",
     "pretest": "pnpm dlx rimraf coverage",
@@ -47,15 +47,16 @@
     "Err"
   ],
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.16.1",
-    "@typescript-eslint/parser": "^7.16.1",
-    "eslint": "^8.57.0",
-    "rollup": "^4.18.1",
+    "@eslint/js": "^9.8.0",
+    "@types/eslint__js": "^8.42.3",
+    "eslint": "^9.8.0",
+    "rollup": "^4.19.2",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-esbuild": "^6.1.1",
-    "typedoc": "^0.26.4",
-    "typedoc-plugin-markdown": "^4.2.1",
-    "typescript": "^5.5.3"
+    "typedoc": "^0.26.5",
+    "typedoc-plugin-markdown": "^4.2.3",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.0"
   },
-  "packageManager": "pnpm@9.5.0"
+  "packageManager": "pnpm@9.6.0"
 }

package/src/enum/constants.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { Result } from './core.ts';
+import { Ok } from './prelude.ts';
+
+/**
+ * Exports some Result constants.
+ */
+
+/**
+ * Result constant for `true`.
+ * Can be used anywhere due to immutability.
+ */
+export const RESULT_TRUE: Result<boolean, any> = Ok(true);
+
+/**
+ * Result constant for `false`.
+ * Can be used anywhere due to immutability.
+ */
+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);