happy-rusty 1.4.0 → 1.6.0

package/docs/type-aliases/AsyncIOResult.md

@@ -1,24 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.md) / AsyncIOResult
-
-# Type Alias: AsyncIOResult\<T\>
-
-```ts
-type AsyncIOResult<T>: AsyncResult<T, Error>;
-```
-
-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 Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the value that is produced by a successful I/O operation. |
-
-## Defined in
-
-[defines.ts:52](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L52)

package/docs/type-aliases/AsyncOption.md

@@ -1,24 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.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`. |
-
-## Defined in
-
-[defines.ts:13](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L13)

package/docs/type-aliases/AsyncResult.md

@@ -1,25 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.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. |
-
-## Defined in
-
-[defines.ts:22](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L22)

package/docs/type-aliases/AsyncVoidIOResult.md

@@ -1,17 +0,0 @@
-[**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

@@ -1,23 +0,0 @@
-[**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

@@ -1,24 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.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. |
-
-## Defined in
-
-[defines.ts:44](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/defines.ts#L44)

package/docs/type-aliases/VoidIOResult.md

@@ -1,17 +0,0 @@
-[**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

@@ -1,23 +0,0 @@
-[**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

@@ -1,18 +0,0 @@
-[**happy-rusty**](../README.md) • **Docs**
-
-***
-
-[happy-rusty](../README.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.
-
-## Defined in
-
-[prelude.ts:10](https://github.com/JiangJie/happy-rusty/blob/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/prelude.ts#L10)

package/docs/variables/RESULT_FALSE.md

@@ -1,18 +0,0 @@
-[**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/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L19)

package/docs/variables/RESULT_TRUE.md

@@ -1,18 +0,0 @@
-[**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/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L13)

package/docs/variables/RESULT_VOID.md

@@ -1,17 +0,0 @@
-[**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

@@ -1,18 +0,0 @@
-[**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/7d7f4ab2132e507f77594d030495f95b5688b84a/src/enum/constants.ts#L25)

package/src/enum/constants.ts

@@ -1,30 +0,0 @@
-/* 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);
-
-/**
- * Result constant for `void` or `()`.
- */
-export const RESULT_VOID: Result<void, any> = Ok();