Class: AsyncOptional<T>
Type parameters
| Name |
|---|
T |
Hierarchy
AsyncOptional
Implements
PromiseLike<Optional<NonNullable<T>>>
Constructors
constructor
• new AsyncOptional<T>()
Type parameters
| Name |
|---|
T |
Methods
asJSON
▸ Abstract asJSON(_): Promise<null | T>
Parameters
| Name | Type |
|---|---|
_ | string |
Returns
Promise<null | T>
Defined in
packages/optional/src/AsyncOptional.ts:172
call
▸ call<K>(key, ...args): AsyncOptionalOf<ReturnType<T[K] extends (...args: any[]) => any ? any[any] : never>>
Invoke a method on the wrapped object and return an optional of the return value
Type parameters
| Name | Type |
|---|---|
K | extends string | number | symbol |
Parameters
| Name | Type |
|---|---|
key | K |
...args | Parameters<T[K] extends (...args: any[]) => any ? any[any] : never> |
Returns
AsyncOptionalOf<ReturnType<T[K] extends (...args: any[]) => any ? any[any] : never>>
Defined in
packages/optional/src/AsyncOptional.ts:98
callAsync
▸ callAsync<K>(key, ...args): AsyncOptionalOf<ReturnType<T[K] extends (...args: any[]) => any ? any[any] : never>>
Invoke a method on the wrapped object and return an Async Optional of the return value
Type parameters
| Name | Type |
|---|---|
K | extends string | number | symbol |
Parameters
| Name | Type |
|---|---|
key | K |
...args | Parameters<T[K] extends (...args: any[]) => Promise<any> ? any[any] : never>[] |
Returns
AsyncOptionalOf<ReturnType<T[K] extends (...args: any[]) => any ? any[any] : never>>
Defined in
packages/optional/src/AsyncOptional.ts:110
defaultGet
▸ defaultGet<X>(method): AsyncOptionalOf<T | X>
Inject a default value to the optional if it is absent to allow continued chaining
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
method | () => X |
Returns
AsyncOptionalOf<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:133
defaultGetAsync
▸ defaultGetAsync<X>(method): AsyncOptionalOf<T | X>
Inject a default value to the optional if it is absent to allow continued
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
method | () => Promise<X> |
Returns
AsyncOptionalOf<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:146
defaultGetFlat
▸ defaultGetFlat<X>(method): AsyncOptionalOf<T | X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
method | () => Optional<X> |
Returns
AsyncOptionalOf<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:136
defaultGetFlatAsync
▸ defaultGetFlatAsync<X>(method): AsyncOptionalOf<T | X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
method | () => AsyncOptional<X> |
Returns
AsyncOptionalOf<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:152
defaultTo
▸ defaultTo<X>(value): AsyncOptionalOf<T | X>
Inject a default value to the optional if it is absent to allow continued chaining
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
value | X |
Returns
AsyncOptionalOf<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:125
filter
▸ Abstract filter<X>(predicate): AsyncOptional<X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
predicate | (value: T) => value is X |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:72
▸ Abstract filter(predicate): AsyncOptional<T>
Parameters
| Name | Type |
|---|---|
predicate | (value: T) => boolean |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:75
filterNot
▸ Abstract filterNot<X>(predicate): AsyncOptional<Exclude<T, X>>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
predicate | (value: T) => value is X |
Returns
AsyncOptional<Exclude<T, X>>
Defined in
packages/optional/src/AsyncOptional.ts:77
▸ Abstract filterNot(predicate): AsyncOptional<T>
Parameters
| Name | Type |
|---|---|
predicate | (value: T) => boolean |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:80
flatMap
▸ Abstract flatMap<X>(transform): AsyncOptional<X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
transform | (value: T) => Optional<X> |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:67
flatMapAsync
▸ Abstract flatMapAsync<X>(transform): AsyncOptionalOf<X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
transform | (value: T) => Promise<Optional<X>> | AsyncOptional<X> |
Returns
AsyncOptionalOf<X>
Defined in
packages/optional/src/AsyncOptional.ts:68
get
▸ Abstract get(): Promise<T>
Returns
Promise<T>
Defined in
packages/optional/src/AsyncOptional.ts:166
instanceOf
▸ instanceOf<C>(...klasses): AsyncOptional<InstanceType<C[number]>>
Type parameters
| Name | Type |
|---|---|
C | extends (...args: any[]) => any[] |
Parameters
| Name | Type |
|---|---|
...klasses | C |
Returns
AsyncOptional<InstanceType<C[number]>>
Defined in
packages/optional/src/AsyncOptional.ts:35
map
▸ Abstract map<X>(transform): AsyncOptionalOf<X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
transform | (value: T) => X |
Returns
AsyncOptionalOf<X>
Defined in
packages/optional/src/AsyncOptional.ts:31
mapAsync
▸ Abstract mapAsync<X>(transform): AsyncOptionalOf<X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
transform | (value: T) => Promise<X> |
Returns
AsyncOptionalOf<X>
Defined in
packages/optional/src/AsyncOptional.ts:33
orElse
▸ Abstract orElse<X>(value): Promise<T | X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
value | X |
Returns
Promise<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:160
orGet
▸ Abstract orGet<X>(supplier): Promise<T | X>
Type parameters
| Name |
|---|
X |
Parameters
| Name | Type |
|---|---|
supplier | () => X |
Returns
Promise<T | X>
Defined in
packages/optional/src/AsyncOptional.ts:162
orThrow
▸ Abstract orThrow(errThrower): Promise<T>
Parameters
| Name | Type |
|---|---|
errThrower | () => Error |
Returns
Promise<T>
Defined in
packages/optional/src/AsyncOptional.ts:164
pick
▸ pick<K>(key): AsyncOptionalOf<T[K]>
Select a field from the wrapped object and return an optional of that field.
Example
ts
Type parameters
| Name | Type |
|---|---|
K | extends string | number | symbol |
Parameters
| Name | Type |
|---|---|
key | K |
Returns
AsyncOptionalOf<T[K]>
Defined in
packages/optional/src/AsyncOptional.ts:91
tap
▸ tap(view): AsyncOptional<T>
Parameters
| Name | Type |
|---|---|
view | (value: T) => unknown |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:43
tapAsync
▸ tapAsync(view): AsyncOptional<T>
Parameters
| Name | Type |
|---|---|
view | (value: T) => Promise<unknown> |
Returns
Defined in
packages/optional/src/AsyncOptional.ts:50
then
▸ Abstract then<TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
Type parameters
| Name | Type |
|---|---|
TResult1 | Optional<NonNullable<T>> |
TResult2 | never |
Parameters
| Name | Type |
|---|---|
onfulfilled? | null | (value: Optional<NonNullable<T>>) => TResult1 | PromiseLike<TResult1> |
onrejected? | null | (reason: any) => TResult2 | PromiseLike<TResult2> |
Returns
PromiseLike<TResult1 | TResult2>
Implementation of
PromiseLike.then
Defined in
packages/optional/src/AsyncOptional.ts:24
toArray
▸ Abstract toArray(): Promise<T[]>
Returns
Promise<T[]>
Defined in
packages/optional/src/AsyncOptional.ts:170
toJSON
▸ Abstract toJSON(_): Promise<null | T>
Parameters
| Name | Type |
|---|---|
_ | string |
Returns
Promise<null | T>
Defined in
packages/optional/src/AsyncOptional.ts:168
unzip
▸ Abstract unzip<V>(this): Promise<OptionalizeArray<OptionalValue<V>>>
Type parameters
| Name | Type |
|---|---|
V | extends AsyncOptional<[any, any], V> |
Parameters
| Name | Type |
|---|---|
this | V |
Returns
Promise<OptionalizeArray<OptionalValue<V>>>
Defined in
packages/optional/src/AsyncOptional.ts:60
unzip3
▸ Abstract unzip3<V>(this): Promise<OptionalizeArray<OptionalValue<V>>>
Type parameters
| Name | Type |
|---|---|
V | extends AsyncOptional<[any, any, any], V> |
Parameters
| Name | Type |
|---|---|
this | V |
Returns
Promise<OptionalizeArray<OptionalValue<V>>>
Defined in
packages/optional/src/AsyncOptional.ts:63
zip
▸ Abstract zip<X>(...others): AsyncOptional<OptionalValuesFromTuple<[Optional<T>, ...X[]]>>
Type parameters
| Name | Type |
|---|---|
X | extends AnyOptional<any>[] |
Parameters
| Name | Type |
|---|---|
...others | X |
Returns
AsyncOptional<OptionalValuesFromTuple<[Optional<T>, ...X[]]>>
Defined in
packages/optional/src/AsyncOptional.ts:57
empty
▸ Static empty<T>(): AsyncOptionalOf<T>
Type parameters
| Name |
|---|
T |
Returns
AsyncOptionalOf<T>
Defined in
packages/optional/src/AsyncOptional.ts:20
of
▸ Static of<T>(promise): AsyncOptionalOf<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
promise | Promise<T> |
Returns
AsyncOptionalOf<T>