Class AsyncRequestState<T>

A RequestState representing a pending async action

Type Parameters

Hierarchy (view full)

IValueRequestState<T>
- AsyncRequestState

Index

Constructors

constructor

new AsyncRequestState<T>(request): AsyncRequestState<T>
Type Parameters
- T
Parameters
- request: Observable<T> | Promise<T>
Returns AsyncRequestState<T>
Overrides IValueRequestState.constructor
- Defined in src/request-state/async-request-state.ts:36

Properties

`Readonly`error

error: Signal<undefined | Error> = ...

Emits the error if one is thrown by the request. Otherwise undefined

`Readonly`failed

failed: Signal<boolean> = ...

Emits true if the request failed

`Readonly`loading

loading: Signal<boolean> = ...

Emits true when the request is running

`Readonly`request$

request$: Observable<T> = ...

The underlying request

`Readonly`result

result: Signal<undefined | T> = ...

The result of the request, or undefined when unresolved

`Readonly`result$

result$: Observable<T> = ...

The result of the request

Accessors

completed

get completed(): boolean
Returns boolean
- Defined in src/request-state/async-request-state.ts:14

Methods

asPromise

asPromise(): Promise<T>
Returns Promise<T>
Inherited from IValueRequestState.asPromise
- Defined in src/request-state/request-state.ts:95

cancel

cancel(error?): boolean
Cancel a running request
Parameters
- Optionalerror: string | Error | (() => Error)
  Optionally provide a custom error to throw when cancelling the request
Returns boolean
Overrides IValueRequestState.cancel
- Defined in src/request-state/async-request-state.ts:83

catch

catch(onError): this
Perform an action if the request fails
Parameters
- onError: ((error: Error) => void)
  - - (error): void
    - Parameters
      error: Error
      Returns void
Returns this
Inherited from IValueRequestState.catch
- Defined in src/request-state/request-state.ts:80

finally

finally(onComplete): this
Perform an action when the request finishes (Error or Success)
Parameters
- onComplete: ((error?: Error) => void)
  - - (error?): void
    - Parameters
      Optionalerror: Error
      Returns void
Returns this
Inherited from IValueRequestState.finally
- Defined in src/request-state/request-state.ts:87

subscribe(observer): Unsubscribable
Subscribe to the underlying request Observable
Parameters
- observer: Partial<Observer<T>>
Returns Unsubscribable
Inherited from IValueRequestState.subscribe
- Defined in src/request-state/request-state.ts:68

then

then(onValue, onError?): this
Perform actions when the request finishes
Parameters
- onValue: ((value: T) => void)
  Action to perform on successful resolution
  - - (value): void
    - Parameters
      value: T
      Returns void
- OptionalonError: ((error: Error) => void)
  Action to perform on error
  - - (error): void
    - Parameters
      error: Error
      Returns void
Returns this
Inherited from IValueRequestState.then
- Defined in src/request-state/request-state.ts:72

Class AsyncRequestState<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AsyncRequestState<T>

Properties

Readonlyerror

Readonlyfailed

Readonlyloading

Readonlyrequest$

Readonlyresult

Readonlyresult$

Accessors

completed

Returns boolean

Methods

asPromise

Returns Promise<T>

cancel

Parameters

Returns boolean

catch

Parameters

Parameters

Returns void

Returns this

finally

Parameters

Parameters

Returns void

Returns this

subscribe

Parameters

Returns Unsubscribable

then

Parameters

Parameters

Returns void

Parameters

Returns void

Returns this

Settings

On This Page

`Readonly`error

`Readonly`failed

`Readonly`loading

`Readonly`request$

`Readonly`result

`Readonly`result$