Class LoadingState<TData>

Represents the loading state of a Command

Type Parameters

TData

Hierarchy (view full)

IValueLoadingState<TData>
- LoadingState
  - DelayedLoadingState

Index

Constructors

Properties

error$ failed$ isAsync loading$ result$

Accessors

loading resultAsync

Methods

cancel catch finally subscribe then

Constructors

constructor

new LoadingState<TData>(data): LoadingState<TData>
Type Parameters
- TData
Parameters
- data: Observable<TData> | Promise<TData> | Subscribable<TData>
Returns LoadingState<TData>
Overrides IValueLoadingState.constructor
- Defined in src/loading-state/loading-state.ts:51

Properties

error$

error$: Observable<Error>

Emits an error if one occurs

failed$

failed$: Observable<boolean>

Indicates if the actions has failed

`Readonly`isAsync

isAsync: true = true

Indicates if the action was async or not

`Readonly`loading$

loading$: Observable<boolean>

Indicates the loading state of the command

`Readonly`result$

result$: Observable<TData>

The result of the action

Accessors

loading

get loading(): boolean
Indicates the loading state of the command

Returns boolean
Overrides IValueLoadingState.loading
- Defined in src/loading-state/loading-state.ts:23

resultAsync

get resultAsync(): Promise<TData>
A promise returning the data once resolved

Returns Promise<TData>
Overrides IValueLoadingState.resultAsync
- Defined in src/loading-state/loading-state.ts:42

Methods

cancel

cancel(): void
Cancel the command This will cancel HTTP requests if used

Returns void
Overrides IValueLoadingState.cancel
- Defined in src/loading-state/loading-state.ts:118

catch

catch(func): this
Define a callback that will be executed on a failed action
Parameters
- func: ((error: Error) => void)
  - - (error): void
    - Parameters
      error: Error
      Returns void
Returns this
Inherited from IValueLoadingState.catch
- Defined in src/loading-state/value-loading-state.interface.ts:26

finally

finally(func): this
Define a callback that will be executed when the action has completed (Whether it failed or succeeded)
Parameters
- func: (() => void)
  - - (): void
    - Returns void
Returns this
Inherited from IValueLoadingState.finally
- Defined in src/loading-state/value-loading-state.interface.ts:35

subscribe

subscribe(observer): Unsubscribable
Subscribe to the loading state
Parameters
- observer: Partial<Observer<boolean>>
Returns Unsubscribable
Inherited from IValueLoadingState.subscribe
- Defined in src/loading-state/loading-state.interface.ts:29

then

then(next, error?): this
Define a callback that will be executed on a successful action
Parameters
- next: ((data: TData) => void)
  - - (data): void
    - Parameters
      data: TData
      Returns void
- Optionalerror: ((error: Error) => void)
  - - (error): void
    - Parameters
      error: Error
      Returns void
Returns this
Inherited from IValueLoadingState.then
- Defined in src/loading-state/value-loading-state.interface.ts:17