Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jarvisjiang committed Aug 3, 2024
1 parent 568a73f commit 79ffe0e
Show file tree
Hide file tree
Showing 17 changed files with 98 additions and 98 deletions.
2 changes: 1 addition & 1 deletion docs/functions/Err.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ if (badResult.isErr()) {

## Defined in

[prelude.ts:413](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L413)
[prelude.ts:413](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L413)
2 changes: 1 addition & 1 deletion docs/functions/Ok.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ if (goodResult.isOk()) {

## Defined in

[prelude.ts:286](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L286)
[prelude.ts:286](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L286)
2 changes: 1 addition & 1 deletion docs/functions/Some.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ if (maybeValue.isSome()) {

## Defined in

[prelude.ts:55](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L55)
[prelude.ts:55](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L55)
2 changes: 1 addition & 1 deletion docs/functions/isOption.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Checks if a value is an `Option`.

## Defined in

[helpers.ts:11](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/helpers.ts#L11)
[helpers.ts:11](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/helpers.ts#L11)
2 changes: 1 addition & 1 deletion docs/functions/isResult.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Checks if a value is a `Result`.

## Defined in

[helpers.ts:24](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/helpers.ts#L24)
[helpers.ts:24](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/helpers.ts#L24)
2 changes: 1 addition & 1 deletion docs/functions/promiseToAsyncResult.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ async function example() {

## Defined in

[extensions.ts:25](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/extensions.ts#L25)
[extensions.ts:25](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/extensions.ts#L25)
56 changes: 28 additions & 28 deletions docs/interfaces/None.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ The type parameter is set to `never` because `None` does not hold a value.

| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
| `[OptionKindSymbol]` | `readonly` | `"None"` | When using `None` alone, the following overrides can make type inference more accurate. | `Option.[OptionKindSymbol]` | - | [prelude.ts:15](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L15) |
| `[toStringTag]` | `public` | `"Option"` | [object Option]. | - | [`Option`](Option.md).`[toStringTag]` | [core.ts:30](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L30) |
| `[OptionKindSymbol]` | `readonly` | `"None"` | When using `None` alone, the following overrides can make type inference more accurate. | `Option.[OptionKindSymbol]` | - | [prelude.ts:15](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L15) |
| `[toStringTag]` | `public` | `"Option"` | [object Option]. | - | [`Option`](Option.md).`[toStringTag]` | [core.ts:30](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L30) |

## Methods

Expand Down Expand Up @@ -55,7 +55,7 @@ This is sometimes called "and then" because it is similar to a logical AND opera

#### Defined in

[prelude.ts:30](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L30)
[prelude.ts:30](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L30)

***

Expand Down Expand Up @@ -92,7 +92,7 @@ The result of `fn` if `this` is `Some`, otherwise `None`.

#### Defined in

[prelude.ts:31](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L31)
[prelude.ts:31](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L31)

***

Expand Down Expand Up @@ -129,7 +129,7 @@ This method can be used for comparing `Option` instances in a value-sensitive ma

#### Defined in

[prelude.ts:36](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L36)
[prelude.ts:36](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L36)

***

Expand Down Expand Up @@ -161,7 +161,7 @@ Throws an error with the provided message if the Option is a `None`.

#### Defined in

[core.ts:76](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L76)
[core.ts:76](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L76)

***

Expand Down Expand Up @@ -191,7 +191,7 @@ Returns `None` if the Option is `None`, otherwise calls predicate with the wrapp

#### Defined in

[prelude.ts:22](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L22)
[prelude.ts:22](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L22)

***

Expand All @@ -215,7 +215,7 @@ Converts from `Option<Option<T>>` to `Option<T>`.

#### Defined in

[prelude.ts:23](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L23)
[prelude.ts:23](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L23)

***

Expand Down Expand Up @@ -246,7 +246,7 @@ This is primarily for side effects and does not transform the `Option`.

#### Defined in

[core.ts:263](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L263)
[core.ts:263](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L263)

***

Expand All @@ -268,7 +268,7 @@ Returns `true` if the Option is a `None` value.

#### Defined in

[core.ts:55](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L55)
[core.ts:55](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L55)

***

Expand All @@ -290,7 +290,7 @@ Returns `true` if the Option is a `Some` value.

#### Defined in

[core.ts:50](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L50)
[core.ts:50](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L50)

***

Expand Down Expand Up @@ -318,7 +318,7 @@ Returns `true` if the Option is a `Some` value and the predicate returns `true`

#### Defined in

[core.ts:61](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L61)
[core.ts:61](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L61)

***

Expand Down Expand Up @@ -352,7 +352,7 @@ Maps an `Option<T>` to `Option<U>` by applying a function to a contained value.

#### Defined in

[prelude.ts:24](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L24)
[prelude.ts:24](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L24)

***

Expand Down Expand Up @@ -387,7 +387,7 @@ Maps an `Option<T>` to `U` by applying a function to the contained value (if any

#### Defined in

[core.ts:159](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L159)
[core.ts:159](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L159)

***

Expand Down Expand Up @@ -422,7 +422,7 @@ Maps an `Option<T>` to `U` by applying a function to a contained value (if any),

#### Defined in

[core.ts:167](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L167)
[core.ts:167](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L167)

***

Expand Down Expand Up @@ -456,7 +456,7 @@ Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to `Ok(v)` a

#### Defined in

[core.ts:109](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L109)
[core.ts:109](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L109)

***

Expand Down Expand Up @@ -490,7 +490,7 @@ Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to `Ok(v)` a

#### Defined in

[core.ts:116](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L116)
[core.ts:116](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L116)

***

Expand Down Expand Up @@ -527,7 +527,7 @@ This can be used for providing a fallback `Option`.

#### Defined in

[prelude.ts:32](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L32)
[prelude.ts:32](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L32)

***

Expand Down Expand Up @@ -564,7 +564,7 @@ This method can be used for lazy fallbacks, as `fn` is only evaluated if `this`

#### Defined in

[prelude.ts:33](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L33)
[prelude.ts:33](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L33)

***

Expand All @@ -586,7 +586,7 @@ Custom `toString` implementation that uses the `Option`'s contained value.

#### Defined in

[core.ts:280](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L280)
[core.ts:280](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L280)

***

Expand All @@ -612,7 +612,7 @@ Transposes an `Option` of a `Result` into a `Result` of an `Option`.

#### Defined in

[prelude.ts:20](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L20)
[prelude.ts:20](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L20)

***

Expand All @@ -638,7 +638,7 @@ Throws an error if the value is a `None`.

#### Defined in

[core.ts:82](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/core.ts#L82)
[core.ts:82](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/core.ts#L82)

***

Expand Down Expand Up @@ -672,7 +672,7 @@ Returns the contained `Some` value or a provided default.

#### Defined in

[prelude.ts:17](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L17)
[prelude.ts:17](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L17)

***

Expand Down Expand Up @@ -706,7 +706,7 @@ Returns the contained `Some` value or computes it from a closure.

#### Defined in

[prelude.ts:18](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L18)
[prelude.ts:18](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L18)

***

Expand All @@ -732,7 +732,7 @@ A tuple of `Options`, one for each element in the original `Option` of a tuple.

#### Defined in

[prelude.ts:28](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L28)
[prelude.ts:28](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L28)

***

Expand Down Expand Up @@ -769,7 +769,7 @@ This can be thought of as an exclusive or operation on `Option` values.

#### Defined in

[prelude.ts:34](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L34)
[prelude.ts:34](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L34)

***

Expand Down Expand Up @@ -807,7 +807,7 @@ An `Option` containing a tuple of the values if both are `Some`, otherwise `None

#### Defined in

[prelude.ts:26](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L26)
[prelude.ts:26](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L26)

***

Expand Down Expand Up @@ -847,4 +847,4 @@ An `Option` containing the result of `fn` if both `Options` are `Some`, otherwis

#### Defined in

[prelude.ts:27](https://github.com/JiangJie/happy-rusty/blob/ba112bb228eba4376da813b0604a1f67c4b2f569/src/enum/prelude.ts#L27)
[prelude.ts:27](https://github.com/JiangJie/happy-rusty/blob/568a73f526d9ce3608e5c5e0ed80e93107bc6adb/src/enum/prelude.ts#L27)
Loading

0 comments on commit 79ffe0e

Please sign in to comment.