happy-rusty 1.0.9 → 1.1.0

package/docs/type-aliases/AsyncOption.md

@@ -0,0 +1,24 @@
+[**happy-rusty**](../index.md) • **Docs**
+
+***
+
+[happy-rusty](../index.md) / AsyncOption
+
+# Type alias: AsyncOption\<T\>
+
+```ts
+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 parameter | Description |
+| :------ | :------ |
+| `T` | The type of the value that may be contained within the `Option`. |
+
+## Source
+
+[enum/prelude.ts:584](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L584)

package/docs/type-aliases/AsyncResult.md

@@ -0,0 +1,25 @@
+[**happy-rusty**](../index.md) • **Docs**
+
+***
+
+[happy-rusty](../index.md) / AsyncResult
+
+# Type alias: AsyncResult\<T, E\>
+
+```ts
+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 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
+
+[enum/prelude.ts:593](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L593)

package/docs/type-aliases/IOResult.md

@@ -0,0 +1,24 @@
+[**happy-rusty**](../index.md) • **Docs**
+
+***
+
+[happy-rusty](../index.md) / IOResult
+
+# Type alias: IOResult\<T\>
+
+```ts
+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 parameter | Description |
+| :------ | :------ |
+| `T` | The type of the value that is produced by a successful operation. |
+
+## Source
+
+[enum/prelude.ts:601](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L601)

package/docs/variables/None.md

@@ -0,0 +1,18 @@
+[**happy-rusty**](../index.md) • **Docs**
+
+***
+
+[happy-rusty](../index.md) / None
+
+# Variable: None
+
+```ts
+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
+
+[enum/prelude.ts:288](https://github.com/JiangJie/happy-rusty/blob/15ed105e08c6cc3943e22243c9386336a521d83e/src/enum/prelude.ts#L288)

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.0.9",
+  "version": "1.1.0",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -14,6 +14,7 @@
     "README.md",
     "README.cn.md",
     "package.json",
+    "docs",
     "src",
     "dist"
   ],
@@ -21,9 +22,14 @@
   "scripts": {
     "check": "pnpm exec tsc --noEmit",
     "lint": "pnpm exec eslint src/",
-    "prebuild": "pnpm exec rimraf dist && pnpm run check && pnpm run lint",
+    "prebuild": "pnpm dlx rimraf dist && pnpm run check && pnpm run lint",
     "build": "pnpm exec rollup --config rollup.config.mjs",
-    "test": "bun test --coverage",
+    "pretest": "pnpm dlx rimraf coverage",
+    "test": "deno test --coverage && deno coverage coverage && deno coverage coverage --lcov --output=coverage/cov_profile.lcov",
+    "pretest:html": "pnpm run pretest",
+    "test:html": "deno test --coverage && deno coverage coverage && deno coverage coverage --html",
+    "predocs": "pnpm dlx rimraf docs",
+    "docs": "pnpm exec typedoc",
     "prepublishOnly": "pnpm run build"
   },
   "repository": {
@@ -41,15 +47,15 @@
     "Err"
   ],
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^7.8.0",
+    "@typescript-eslint/eslint-plugin": "^7.12.0",
+    "@typescript-eslint/parser": "^7.12.0",
     "eslint": "^8.57.0",
-    "rimraf": "^5.0.5",
-    "rollup": "^4.17.2",
-    "rollup-plugin-dts": "^6.1.0",
+    "rollup": "^4.18.0",
+    "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"
   },
-  "packageManager": "pnpm@9.1.1+sha512.14e915759c11f77eac07faba4d019c193ec8637229e62ec99eefb7cf3c3b75c64447882b7c485142451ee3a6b408059cdfb7b7fa0341b975f12d0f7629c71195"
+  "packageManager": "pnpm@9.2.0"
 }