Class InternalAsyncPropClass<Value, Params>

Class for constructing async props. Do not use this directly as its internal types won't be inferred correctly. Instead use asyncProp an async prop or AsyncProp for types.

Type Parameters

Value
Params

Hierarchy

CallbackObservable<Value, Params>
- InternalAsyncPropClass

Index

Constructors

constructor

Methods

isError isNotError isResolved isSettled isWaiting

Constructors

constructor

new InternalAsyncPropClass<Value, Params>(
init?: Readonly<Partial<{}>>,
): InternalAsyncPropClass<Value, Params>
Type Parameters
- Value
- Params
Parameters
- Optionalinit: Readonly<Partial<{}>>
Returns InternalAsyncPropClass<Value, Params>
Inherited from CallbackObservable<Value, Params>.constructor
- Defined in node_modules/observavir/dist/callback-observable.d.ts:65

Methods

isError

isError(): this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{ value: Error | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Error> },
>
Checks if the current .value is a rejection error. This type guards the current instance's .value property.

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{ value: Error | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Error> },
>
- Defined in packages/element-vir/src/declarative-element/directives/async-prop.ts:44

isNotError

isNotError(): this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Error>;
    },
>
Checks if the current .value is resolved (and not an error) or still waiting. This type guards the current instance's .value property.

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Error>;
    },
>
- Defined in packages/element-vir/src/declarative-element/directives/async-prop.ts:52

isResolved

isResolved(): this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value: Exclude<
            Exclude<Awaited<Value>, typeof noUpdate>,
            Error | Promise<any>,
        >;
    },
>
Checks if the current .value has resolved (meaning the Promise has settled and it was not rejected). This type guards the current instance's .value property.

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value: Exclude<
            Exclude<Awaited<Value>, typeof noUpdate>,
            Error | Promise<any>,
        >;
    },
>
- Defined in packages/element-vir/src/declarative-element/directives/async-prop.ts:17

isSettled

isSettled(): this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Error
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>
Checks if the current .value has settled (meaning it is either a rejection error or a resolved value). This type guards the current instance's .value property.

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Error
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>
- Defined in packages/element-vir/src/declarative-element/directives/async-prop.ts:28

isWaiting

isWaiting(): this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>
Checks if the current .value has not settled yet settled (meaning it is still an unsettled Promise). This type guards the current instance's .value property.

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>
- Defined in packages/element-vir/src/declarative-element/directives/async-prop.ts:36

Class InternalAsyncPropClass<Value, Params>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InternalAsyncPropClass<Value, Params>

Methods

isError

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{ value: Error | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Error> },
>

isNotError

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Error>;
    },
>

isResolved

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value: Exclude<
            Exclude<Awaited<Value>, typeof noUpdate>,
            Error | Promise<any>,
        >;
    },
>

isSettled

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Error
            | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>

isWaiting

Returns this is Overwrite<
    InternalAsyncPropClass<Value, Params>,
    {
        value:
            | Promise<Exclude<Awaited<Value>, typeof noUpdate>>
            | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
    },
>

Settings

On This Page

Class InternalAsyncPropClass<Value, Params>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InternalAsyncPropClass<Value, Params>

Methods

isError

Returns this is Overwrite< InternalAsyncPropClass<Value, Params>, { value: Error | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Error> },>

isNotError

Returns this is Overwrite< InternalAsyncPropClass<Value, Params>, { value: | Promise<Exclude<Awaited<Value>, typeof noUpdate>> | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Error>; },>

isResolved

Returns this is Overwrite< InternalAsyncPropClass<Value, Params>, { value: Exclude< Exclude<Awaited<Value>, typeof noUpdate>, Error | Promise<any>, >; },>

isSettled

Returns this is Overwrite< InternalAsyncPropClass<Value, Params>, { value: | Error | Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>; },>

isWaiting

Returns this is Overwrite< InternalAsyncPropClass<Value, Params>, { value: | Promise<Exclude<Awaited<Value>, typeof noUpdate>> | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>; },>

Settings

On This Page

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{ value: Error | Extract<Exclude<Awaited<Value>, typeof noUpdate>, Error> },
>

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{
value:
| Promise<Exclude<Awaited<Value>, typeof noUpdate>>
| Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Error>;
},
>

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{
value: Exclude<
Exclude<Awaited<Value>, typeof noUpdate>,
Error | Promise<any>,
>;
},
>

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{
value:
| Error
| Exclude<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
},
>

Returns this is Overwrite<
InternalAsyncPropClass<Value, Params>,
{
value:
| Promise<Exclude<Awaited<Value>, typeof noUpdate>>
| Extract<Exclude<Awaited<Value>, typeof noUpdate>, Promise<any>>;
},
>