happy-rusty 1.5.0 → 1.6.1

package/package.json

@@ -1,33 +1,39 @@
 {
   "name": "happy-rusty",
-  "description": "Porting some excellent design implementations from Rust to JavaScript.",
+  "description": "Rust's Option, Result, and sync primitives for JavaScript/TypeScript - Better error handling and null-safety patterns.",
   "author": "jiang115jie@gmail.com",
-  "license": "GPL-3.0",
-  "version": "1.5.0",
+  "license": "MIT",
+  "version": "1.6.1",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
   "module": "dist/main.mjs",
   "types": "dist/types.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "default": "./dist/main.mjs"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "LICENSE",
     "README.md",
     "README.cn.md",
-    "package.json",
-    "docs",
-    "src",
+    "CHANGELOG.md",
     "dist"
   ],
   "sideEffects": false,
   "scripts": {
     "check": "pnpm exec tsc --noEmit",
     "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",
-    "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",
+    "prebuild": "pnpm run check && pnpm run lint",
+    "build": "pnpm exec vite build && pnpm exec rollup --config rollup.config.ts",
+    "test": "pnpm exec vitest run --coverage",
+    "test:watch": "pnpm exec vitest",
+    "test:ui": "pnpm exec vitest --ui",
     "predocs": "pnpm dlx rimraf docs",
     "docs": "pnpm exec typedoc",
     "eg": "deno run -A examples/main.ts",
@@ -39,25 +45,32 @@
   },
   "keywords": [
     "rust",
+    "typescript",
     "enum",
     "Option",
     "Some",
     "None",
     "Result",
     "Ok",
-    "Err"
+    "Err",
+    "Once",
+    "Lazy",
+    "Mutex",
+    "ControlFlow",
+    "error-handling",
+    "null-safety"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.9.0",
-    "@types/eslint__js": "^8.42.3",
-    "eslint": "^9.9.0",
-    "rollup": "^4.20.0",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-esbuild": "^6.1.1",
-    "typedoc": "^0.26.5",
-    "typedoc-plugin-markdown": "^4.2.3",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.0.1"
-  },
-  "packageManager": "pnpm@9.7.0"
+    "@eslint/js": "^9.39.2",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^9.39.2",
+    "rollup": "^4.53.5",
+    "rollup-plugin-dts": "^6.3.0",
+    "typedoc": "^0.28.15",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.50.0",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16"
+  }
 }

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/docs/README.md

@@ -1,47 +0,0 @@
-**happy-rusty** • **Docs**
-
-***
-
-# happy-rusty
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [None](interfaces/None.md) | 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. |
-| [Option](interfaces/Option.md) | Type `Option` represents an optional value: every `Option` is either `Some` and contains a value, or `None`, and does not. This interface includes methods that act on the `Option` type, similar to Rust's `Option` enum. |
-| [Result](interfaces/Result.md) | The `Result` type is used for returning and propagating errors. It is an enum with the variants, `Ok(T)`, representing success and containing a value, and `Err(E)`, representing error and containing an error value. This interface includes methods that act on the `Result` type, similar to Rust's `Result` enum. |
-
-## Type Aliases
-
-| Type alias | Description |
-| ------ | ------ |
-| [AsyncIOResult](type-aliases/AsyncIOResult.md) | 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. |
-| [AsyncOption](type-aliases/AsyncOption.md) | 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. |
-| [AsyncResult](type-aliases/AsyncResult.md) | 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. |
-| [AsyncVoidIOResult](type-aliases/AsyncVoidIOResult.md) | `VoidIOResult` wrapped by `Promise`. |
-| [AsyncVoidResult](type-aliases/AsyncVoidResult.md) | `VoidResult<E>` wrapped by `Promise`. |
-| [IOResult](type-aliases/IOResult.md) | 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. |
-| [VoidIOResult](type-aliases/VoidIOResult.md) | Similar to Rust's `Result<(), Error>`. |
-| [VoidResult](type-aliases/VoidResult.md) | Similar to Rust's `Result<(), E>`. |
-
-## Variables
-
-| Variable | Description |
-| ------ | ------ |
-| [None](variables/None.md) | 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. |
-| [RESULT\_FALSE](variables/RESULT_FALSE.md) | Result constant for `false`. Can be used anywhere due to immutability. |
-| [RESULT\_TRUE](variables/RESULT_TRUE.md) | Result constant for `true`. Can be used anywhere due to immutability. |
-| [RESULT\_VOID](variables/RESULT_VOID.md) | Result constant for `void` or `()`. |
-| [RESULT\_ZERO](variables/RESULT_ZERO.md) | Result constant for `0`. Can be used anywhere due to immutability. |
-
-## Functions
-
-| Function | Description |
-| ------ | ------ |
-| [Err](functions/Err.md) | Creates a `Result<T, E>` representing a failed outcome containing an error. This function is used to construct a `Result` that signifies the operation failed by containing the error `E`. |
-| [Ok](functions/Ok.md) | Creates a `Result<T, E>` representing a successful outcome containing a value. This function is used to construct a `Result` that signifies the operation was successful by containing the value `T`. |
-| [Some](functions/Some.md) | Creates an `Option<T>` representing the presence of a value. This function is typically used to construct an `Option` that contains a value, indicating that the operation yielding the value was successful. |
-| [isOption](functions/isOption.md) | Checks if a value is an `Option`. |
-| [isResult](functions/isResult.md) | Checks if a value is a `Result`. |
-| [promiseToAsyncResult](functions/promiseToAsyncResult.md) | Converts a Promise to a Result type, capturing the resolved value in an `Ok`, or the error in an `Err`. This allows for promise-based asynchronous operations to be handled in a way that is more in line with the Result pattern. |

package/docs/functions/Err.md

@@ -1,46 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / Err
-
-# Function: Err()
-
-```ts
-function Err<T, E>(error): Result<T, E>
-```
-
-Creates a `Result<T, E>` representing a failed outcome containing an error.
-This function is used to construct a `Result` that signifies the operation failed by containing the error `E`.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the value that the result could potentially contain (not used in this case). |
-| `E` | The type of the error to be wrapped in the `Err` result. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `error` | `E` | The error to wrap as an `Err` result. |
-
-## Returns
-
-[`Result`](../interfaces/Result.md)\<`T`, `E`\>
-
-A `Result<T, E>` that contains the provided error, representing the `Err` case.
-
-## Example
-
-```ts
-const badResult = Err<number, Error>(new Error('Something went wrong'));
-if (badResult.isErr()) {
-  console.error(badResult.unwrapErr()); // Outputs: Error: Something went wrong
-}
-```
-
-## Defined in
-
-[prelude.ts:473](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/prelude.ts#L473)

package/docs/functions/Ok.md

@@ -1,70 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / Ok
-
-# Function: Ok()
-
-## Ok(value)
-
-```ts
-function Ok<T, E>(value): Result<T, E>
-```
-
-Creates a `Result<T, E>` representing a successful outcome containing a value.
-This function is used to construct a `Result` that signifies the operation was successful by containing the value `T`.
-
-### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the value to be contained in the `Ok` result. |
-| `E` | The type of the error that the result could potentially contain (not used in this case). |
-
-### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `T` | The value to wrap as an `Ok` result. |
-
-### Returns
-
-[`Result`](../interfaces/Result.md)\<`T`, `E`\>
-
-A `Result<T, E>` that contains the provided value, representing the `Ok` case.
-
-### Example
-
-```ts
-const goodResult = Ok<number, Error>(1); // Result<number, Error> with a value
-if (goodResult.isOk()) {
-  console.log(goodResult.unwrap()); // Outputs: 1
-}
-```
-
-### Defined in
-
-[prelude.ts:326](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/prelude.ts#L326)
-
-## Ok()
-
-```ts
-function Ok<E>(): Result<void, E>
-```
-
-Because javascript does not have a `()` type, use `void` instead.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `E` |
-
-### Returns
-
-[`Result`](../interfaces/Result.md)\<`void`, `E`\>
-
-### Defined in
-
-[prelude.ts:330](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/prelude.ts#L330)

package/docs/functions/Some.md

@@ -1,45 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / Some
-
-# Function: Some()
-
-```ts
-function Some<T>(value): Option<T>
-```
-
-Creates an `Option<T>` representing the presence of a value.
-This function is typically used to construct an `Option` that contains a value, indicating that the operation yielding the value was successful.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the value to be wrapped in a `Some`. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `T` | The value to wrap as a `Some` option. |
-
-## Returns
-
-[`Option`](../interfaces/Option.md)\<`T`\>
-
-An `Option<T>` that contains the provided value, representing the `Some` case.
-
-## Example
-
-```ts
-const maybeValue = Some(1); // Option<number> with a value
-if (maybeValue.isSome()) {
-    console.log(maybeValue.unwrap()); // Outputs: 1
-}
-```
-
-## Defined in
-
-[prelude.ts:71](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/prelude.ts#L71)

package/docs/functions/isOption.md

@@ -1,35 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / isOption
-
-# Function: isOption()
-
-```ts
-function isOption<T>(o): o is Option<T>
-```
-
-Checks if a value is an `Option`.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The expected type of the value contained within the `Option`. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `o` | `unknown` | The value to be checked as an `Option`. |
-
-## Returns
-
-`o is Option<T>`
-
-`true` if the value is an `Option`, otherwise `false`.
-
-## Defined in
-
-[utils.ts:11](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/utils.ts#L11)

package/docs/functions/isResult.md

@@ -1,36 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / isResult
-
-# Function: isResult()
-
-```ts
-function isResult<T, E>(r): r is Result<T, E>
-```
-
-Checks if a value is a `Result`.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The expected type of the success value contained within the `Result`. |
-| `E` | The expected type of the error value contained within the `Result`. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `r` | `unknown` | The value to be checked as a `Result`. |
-
-## Returns
-
-`r is Result<T, E>`
-
-`true` if the value is a `Result`, otherwise `false`.
-
-## Defined in
-
-[utils.ts:24](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/utils.ts#L24)

package/docs/functions/promiseToAsyncResult.md

@@ -1,50 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / promiseToAsyncResult
-
-# Function: promiseToAsyncResult()
-
-```ts
-function promiseToAsyncResult<T, E>(p): Promise<Result<T, E>>
-```
-
-Converts a Promise to a Result type, capturing the resolved value in an `Ok`, or the error in an `Err`.
-This allows for promise-based asynchronous operations to be handled in a way that is more in line with the Result pattern.
-
-## Type Parameters
-
-| Type Parameter | Default type | Description |
-| ------ | ------ | ------ |
-| `T` | - | The type of the value that the promise resolves to. |
-| `E` | `Error` | The type of the error that the promise may reject with, defaults to `Error`. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `p` | `Promise`\<`T`\> | The promise to convert into a `Result` type. |
-
-## Returns
-
-`Promise`\<[`Result`](../interfaces/Result.md)\<`T`, `E`\>\>
-
-A promise that resolves to a `Result<T, E>`. If the input promise `p` resolves, the resulting promise will resolve with `Ok<T>`. If the input promise `p` rejects, the resulting promise will resolve with `Err<E>`.
-
-## Example
-
-```ts
-async function example() {
-    const result = await promiseToAsyncResult(fetchData());
-    result.inspect(x => {
-        console.log('Data:', x);
-    }).inspectErr(err => {
-        console.error('Error:', err);
-    });
-}
-```
-
-## Defined in
-
-[extensions.ts:25](https://github.com/JiangJie/happy-rusty/blob/6efe20969984552f52d79aee092bb6925a077fe7/src/enum/extensions.ts#L25)