Module: @sapphire/result
Namespaces
Classes
Interfaces
Type Aliases
Option
The union of the two variations of Option.
Typeparam
T The value's type.
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/result/src/lib/Option.ts:13
projects/utilities/packages/result/src/lib/Option.ts:15
Result
Ƭ Result<T, E>: Ok<T> | Err<E>
The union of the two variations of Result.
Typeparam
T The result's type.
Typeparam
E The error's type.
Type parameters
| Name |
|---|
T |
E |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:14
projects/utilities/packages/result/src/lib/Result.ts:16
Variables
none
• Const none: None
Defined in
projects/utilities/packages/result/src/lib/Option/None.ts:169
Functions
err
▸ err(): Err<unknown>
Creates an Err with no error.
Returns
Err<unknown>
An erroneous Result.
Defined in
projects/utilities/packages/result/src/lib/Result/Err.ts:191
▸ err<E>(x): Err<E>
Creates an Err.
Type parameters
| Name |
|---|
E |
Parameters
| Name | Type | Description |
|---|---|---|
x | E | Value to use. |
Returns
Err<E>
An erroneous Result.
Typeparam
E The error's type.
Defined in
projects/utilities/packages/result/src/lib/Result/Err.ts:199
ok
▸ ok(): Ok<unknown>
Creates an Ok with no value.
Returns
Ok<unknown>
A successful Result.
Defined in
projects/utilities/packages/result/src/lib/Result/Ok.ts:197
▸ ok<T>(x): Ok<T>
Creates an Ok.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | T | Value to use. |
Returns
Ok<T>
A successful Result.
Typeparam
T The result's type.
Defined in
projects/utilities/packages/result/src/lib/Result/Ok.ts:205
some
▸ some<T>(value): Some<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | T |
Returns
Some<T>
Defined in
projects/utilities/packages/result/src/lib/Option/Some.ts:186