Namespace: Result
@sapphire/result.Result
Type Aliases
Err
Ƭ Err<E>: Err<E>
Type parameters
| Name |
|---|
E |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:97
Ok
Ƭ Ok<T>: Ok<T>
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:98
Resolvable
Ƭ Resolvable<T, E>: T | Result<T, E>
Type parameters
| Name |
|---|
T |
E |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:17
UnwrapErr
Ƭ UnwrapErr<T>: T extends Err<infer S> ? S : never
Type parameters
| Name | Type |
|---|---|
T | extends Result<any, any> |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:101
UnwrapErrArray
Ƭ UnwrapErrArray<T>: { -readonly [P in keyof T]: UnwrapErr<T[P]> }
Type parameters
| Name | Type |
|---|---|
T | extends readonly Result<any, any>[] | [] |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:106
UnwrapOk
Ƭ UnwrapOk<T>: T extends Ok<infer S> ? S : never
Type parameters
| Name | Type |
|---|---|
T | extends Result<any, any> |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:100
UnwrapOkArray
Ƭ UnwrapOkArray<T>: { -readonly [P in keyof T]: UnwrapOk<T[P]> }
Type parameters
| Name | Type |
|---|---|
T | extends readonly Result<any, any>[] | [] |
Defined in
projects/utilities/packages/result/src/lib/Result.ts:103
Functions
all
▸ all<T>(results): Result<UnwrapOkArray<T>, UnwrapErrArray<T>[number]>
Creates an Ok that is the combination of all collected Ok values as an array, or the first Err encountered.
Type parameters
| Name | Type |
|---|---|
T | extends readonly Result<any, any>[] |
Parameters
| Name | Type | Description |
|---|---|---|
results | [...T[]] | An array of Results. |
Returns
Result<UnwrapOkArray<T>, UnwrapErrArray<T>[number]>
A new Result.
Defined in
projects/utilities/packages/result/src/lib/Result.ts:63
any
▸ any<T>(results): Result<UnwrapOkArray<T>[number], UnwrapErrArray<T>>
Returns the first encountered Ok, or an Err that is the combination of all collected error values.
Type parameters
| Name | Type |
|---|---|
T | extends readonly Result<any, any>[] |
Parameters
| Name | Type | Description |
|---|---|---|
results | [...T[]] | An array of Results. |
Returns
Result<UnwrapOkArray<T>[number], UnwrapErrArray<T>>
A new Result.
Defined in
projects/utilities/packages/result/src/lib/Result.ts:81
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.
Typeparam
E The error's type.
Type parameters
| Name |
|---|
E |
Parameters
| Name | Type | Description |
|---|---|---|
x | E | Value to use. |
Returns
Err<E>
An erroneous Result.
Defined in
projects/utilities/packages/result/src/lib/Result/Err.ts:199
from
▸ from<T, E>(op): Result<T, E>
Creates a Result out of a callback.
Typeparam
T The result's type.
Typeparam
E The error's type.
Type parameters
| Name | Type |
|---|---|
T | T |
E | unknown |
Parameters
| Name | Type |
|---|---|
op | Resolvable<T, E> | () => Resolvable<T, E> |
Returns
Result<T, E>
Defined in
projects/utilities/packages/result/src/lib/Result.ts:34
fromAsync
▸ fromAsync<T, E>(op): Promise<Result<T, E>>
Creates a Result out of a promise or async callback.
Typeparam
T The result's type.
Typeparam
E The error's type.
Type parameters
| Name | Type |
|---|---|
T | T |
E | unknown |
Parameters
| Name | Type |
|---|---|
op | Awaitable<Resolvable<T, E>> | () => Awaitable<Resolvable<T, E>> |
Returns
Defined in
projects/utilities/packages/result/src/lib/Result.ts:49
is
▸ is<T, E>(value): true
Type parameters
| Name |
|---|
T |
E |
Parameters
| Name | Type |
|---|---|
value | Result<T, E> |
Returns
true
Defined in
projects/utilities/packages/result/src/lib/Result.ts:23
▸ is(value): value is Result<unknown, unknown>
Parameters
| Name | Type |
|---|---|
value | any |
Returns
value is Result<unknown, unknown>
Defined in
projects/utilities/packages/result/src/lib/Result.ts:24
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.
Typeparam
T The result's type.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | T | Value to use. |
Returns
Ok<T>
A successful Result.