Namespace: Option
Type Aliases
None
Ƭ None: None
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1850
Resolvable
Ƭ Resolvable<T>: T | null | undefined | Option<T>
Type parameters
| Name |
|---|
T |
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1821
Some
Ƭ Some<T>: Some<T>
Type parameters
| Name |
|---|
T |
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1849
UnwrapSome
Ƭ UnwrapSome<T>: T extends Some<infer S> ? S : never
Type parameters
| Name | Type |
|---|---|
T | extends Option<any> |
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1851
UnwrapSomeArray
Ƭ UnwrapSomeArray<T>: { -readonly [P in keyof T]: UnwrapSome<T[P]> }
Type parameters
| Name | Type |
|---|---|
T | extends readonly Option<any>[] | [] |
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1852
Variables
none
• Const none: None
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1847
Functions
all
▸ all<T>(options): Option<UnwrapSomeArray<T>>
Creates a Some that is the combination of all collected Some values as an array, or the first None encountered.
Type parameters
| Name | Type |
|---|---|
T | extends readonly Option<any>[] |
Parameters
| Name | Type | Description |
|---|---|---|
options | [...T[]] | An array of Options. |
Returns
A new Option.
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1840
any
▸ any<T>(options): Option<UnwrapSomeArray<T>[number]>
Returns the first encountered Some, or a None if none was found.
Type parameters
| Name | Type |
|---|---|
T | extends readonly Option<any>[] |
Parameters
| Name | Type | Description |
|---|---|---|
options | [...T[]] | An array of Options. |
Returns
Option<UnwrapSomeArray<T>[number]>
A new Option.
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1846
from
▸ from<T>(op): Option<T>
Creates an Option out of a value or callback.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
op | Resolvable<T> | () => Resolvable<T> |
Returns
Option<T>
Typeparam
T The result's type.
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1828
fromAsync
▸ fromAsync<T>(op): Promise<Option<T>>
Creates an Option out of a value or callback.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
op | Awaitable<Resolvable<T>> | () => Awaitable<Resolvable<T>> |
Returns
Typeparam
T The result's type.
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1833
is
▸ is<T>(value): true
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | Option<T> |
Returns
true
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1822
▸ is(value): value is Option<unknown>
Parameters
| Name | Type |
|---|---|
value | any |
Returns
value is Option<unknown>
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1823
some
▸ some<T>(value): Some<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | T |
Returns
Some<T>
Defined in
node_modules/@sapphire/result/dist/esm/index.d.mts:1848