Class WritableRequestState<T>

A manually populated RequestState

Type Parameters

Hierarchy (view full)

IValueRequestState<T>
- WritableRequestState

Index

Constructors

constructor

new WritableRequestState<T>(onCancel?): WritableRequestState<T>
Type Parameters
- T
Parameters
- OptionalonCancel: (() => void)
  - - (): void
    - Returns void
Returns WritableRequestState<T>
Overrides IValueRequestState.constructor
- Defined in src/request-state/writable-request-state.ts:41

Properties

`Readonly`cancelled

cancelled: Signal<boolean> = ...

Emits true when the RequestState has been cancelled by a consumer, otherwise emits false

`Readonly`cancelled$

cancelled$: Observable<true> = ...

Emits true when the RequestState has been cancelled by a consumer

`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/writable-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

asReadonly

asReadonly(): IValueRequestState<T>
Create a Readonly version of the RequestState

Returns IValueRequestState<T>
- Defined in src/request-state/writable-request-state.ts:48

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/writable-request-state.ts:86

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

setError

setError(error): void
Set the RequestState to an Error state
Parameters
- error: unknown
  The error for the RequestState
Returns void
- Defined in src/request-state/writable-request-state.ts:56

setValue

setValue(value): void
Set the RequestState to a completed state with a given value
Parameters
- value: T
  The value to emit
Returns void
- Defined in src/request-state/writable-request-state.ts:72

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 WritableRequestState<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns void

Returns WritableRequestState<T>

Properties

Readonlycancelled

Readonlycancelled$

Readonlyerror

Readonlyfailed

Readonlyloading

Readonlyrequest$

Readonlyresult

Readonlyresult$

Accessors

completed

Returns boolean

Methods

asPromise

Returns Promise<T>

asReadonly

Returns IValueRequestState<T>

cancel

Parameters

Returns boolean

catch

Parameters

Parameters

Returns void

Returns this

finally

Parameters

Parameters

Returns void

Returns this

setError

Parameters

Returns void

setValue

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribable

then

Parameters

Parameters

Returns void

Parameters

Returns void

Returns this

Settings

On This Page

`Readonly`cancelled

`Readonly`cancelled$

`Readonly`error

`Readonly`failed

`Readonly`loading

`Readonly`request$

`Readonly`result

`Readonly`result$