Class AsyncData<D, E>

This class represents data from a remote source that takes time to load.

It can be single-valued or an array of values. The caller is expected to know which it is

Type Parameters

D
A type representing the shape of data that is being requested
E = {}
A type representing the shape of errors that can be returned

Index

Constructors

`Private` constructor

new AsyncData<D, E>(__namedParameters): AsyncData<D, E>
Type Parameters
- D
- E = {}
Parameters
- __namedParameters: {
 data?: readonly D[];
 error?: E;
 status: RemoteDataStatus;
 }
 - Optional data?: readonly D[]
 - Optional error?: E
 - status: RemoteDataStatus
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:36

Properties

`Private` `Readonly` internal

internal: Either<E, readonly D[]>

`Protected` status

status: RemoteDataStatus = RemoteDataStatus.NotAsked

Methods

all

all(predicate): boolean
This returns true if the predicate returns true for every element of data.

It is synonymous with every
Parameters
- predicate: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: D
      index: number
      array: D[]
      Returns boolean
Returns boolean
Throws
an error if no response has been received
- Defined in src/AsyncData.ts:375

any

any(predicate): boolean
This returns true if the predicate returns true for any element of data.

It is synonymous with some
Parameters
- predicate: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: D
      index: number
      array: D[]
      Returns boolean
Returns boolean
Throws
an error if no response has been received
- Defined in src/AsyncData.ts:397

append

append(v): AsyncData<D, {}>
Parameters
- v: D[]
Returns AsyncData<D, {}>
- Defined in src/AsyncData.ts:249

`Private` cloneWithNewData

cloneWithNewData(data): AsyncData<U, E>
Type Parameters
- U
Parameters
- data: readonly U[]
Returns AsyncData<U, E>
- Defined in src/AsyncData.ts:113

concat

concat(...items): AsyncData<D, E>
Parameters
- Rest ...items: (D | ConcatArray<D>)[]
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:342

containsData

containsData(): boolean
Returns boolean
true if this object currently contains retrievable data, i.e. not an error and not an inflight request
- Defined in src/AsyncData.ts:124

every

every(predicate): boolean
This returns true if the predicate returns true for every element of data.

It is synonymous with all
Parameters
- predicate: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: D
      index: number
      array: D[]
      Returns boolean
Returns boolean
Throws
an error if no response has been received
- Defined in src/AsyncData.ts:386

filter

filter(callbackfn): AsyncData<D, E>
Parameters
- callbackfn: ((value, index?, array?) => boolean)
 - - (value, index?, array?): boolean
 - Parameters
 value: D
 Optional index: number
 Optional array: readonly D[]
 Returns boolean
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:287

find

find(predicate, thisArg?): undefined | D
Parameters
- predicate: ((value, index, obj) => boolean)
  - - (value, index, obj): boolean
    - Parameters
      value: D
      index: number
      obj: readonly D[]
      Returns boolean
- Optional thisArg: unknown
Returns undefined | D
- Defined in src/AsyncData.ts:313

findIndex

findIndex(predicate, thisArg?): number
Parameters
- predicate: ((value, index, obj) => boolean)
  - - (value, index, obj): boolean
    - Parameters
      value: D
      index: number
      obj: readonly D[]
      Returns boolean
- Optional thisArg: unknown
Returns number
- Defined in src/AsyncData.ts:324

get

get(index): D
Parameters
- index: number
Returns D
- Defined in src/AsyncData.ts:360

getAllOptional

getAllOptional(): Optional<readonly D[]>
Get the data as an optional and treat it as an array

This will return any internal data that exists. As a result, it will return data after a call to loadMore.

Returns Optional<readonly D[]>
- Defined in src/AsyncData.ts:226

`Private` getNonLoadedResult

getNonLoadedResult(): undefined | AsyncData<U, E>
Standard response for mapping this AsyncData to a new one when no data is loaded
Type Parameters
- U
Returns undefined | AsyncData<U, E>
- Defined in src/AsyncData.ts:258

getOptional

getOptional(): Optional<D>
Get the data as an optional and treat it as a single value

Returns Optional<D>
- Defined in src/AsyncData.ts:216

is

is(status): boolean
Check the status of the data request
Parameters
- status: RemoteDataStatus
Returns boolean
- Defined in src/AsyncData.ts:133

`Private` isArray

isArray(v): v is readonly D[]
Parameters
- v: D | readonly D[]
Returns v is readonly D[]
- Defined in src/AsyncData.ts:232

isAsked

isAsked(): boolean
Check whether data has been requested

Returns boolean
- Defined in src/AsyncData.ts:140

isEmpty

isEmpty(): boolean
Checks whether the data that was loaded is empty.

This will throw an error if the data is not loaded yet

Returns boolean
Throws
- Defined in src/AsyncData.ts:172

isErrored

isErrored(): boolean
Check whether the data errored out

Returns boolean
- Defined in src/AsyncData.ts:161

isLoaded

isLoaded(): boolean
Check whether any data has loaded (or that the request has failed)

Returns boolean
- Defined in src/AsyncData.ts:154

isLoading

isLoading(): boolean
Check whether data is currently loading

Returns boolean
- Defined in src/AsyncData.ts:147

loadMore

loadMore(): AsyncData<D, E>
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:202

map

map(callbackfn): AsyncData<U, E>
Type Parameters
- U
Parameters
- callbackfn: ((value, index, array?) => U)
 - - (value, index, array?): U
 - Parameters
 value: D
 index: number
 Optional array: readonly D[]
 Returns U
Returns AsyncData<U, E>
- Defined in src/AsyncData.ts:272

mapValue

mapValue(callbackfn): readonly U[]
Type Parameters
- U
Parameters
- callbackfn: ((value, index, array?) => U)
  - - (value, index, array?): U
    - Parameters
      value: D
      index: number
      Optional array: readonly D[]
      Returns U
Returns readonly U[]
- Defined in src/AsyncData.ts:281

orElse

orElse(v): D | readonly D[]
Treats the data as an Optional and returns the internal value or the provided value.
Parameters
- v: D | readonly D[]
Returns D | readonly D[]
- Defined in src/AsyncData.ts:242

reduce

reduce(callbackfn, initialValue): AsyncData<U, E>
Type Parameters
- U
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
 - - (previousValue, currentValue, currentIndex, array): U
 - Parameters
 previousValue: U
 currentValue: D
 currentIndex: number
 array: readonly D[]
 Returns U
- initialValue: U
Returns AsyncData<U, E>
- Defined in src/AsyncData.ts:296

remove

remove(index): AsyncData<D, E>
Parameters
- index: number
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:364

singleValue

singleValue(): D
Returns D
- Defined in src/AsyncData.ts:194

some

some(predicate): boolean
This returns true if the predicate returns true for any element of data.

It is synonymous with any
Parameters
- predicate: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: D
      index: number
      array: D[]
      Returns boolean
Returns boolean
Throws
an error if no response has been received
- Defined in src/AsyncData.ts:408

sort

sort(compareFn?): D[]
Sorts the elements of data, according to compareFn

Note that this does not sort the elements in place
Parameters
- Optional compareFn: ((a, b) => number)
  The comparison function to be applied to the data elements. See Array.sort documentation for more detail
  - - (a, b): number
    - Parameters
      a: D
      b: D
      Returns number
Returns D[]
Throws
an error if no response has been received
- Defined in src/AsyncData.ts:356

update

update(index, value): AsyncData<D, E>
Parameters
- index: number
- value: D
Returns AsyncData<D, E>
- Defined in src/AsyncData.ts:331

value

value(): readonly D[]
Returns readonly D[]
- Defined in src/AsyncData.ts:180

`Static` errored

errored<ED, EE>(error): AsyncData<ED, EE>
Create an instance of this type that indicates that the requests has errored.
Type Parameters
- ED
- EE = {}
Parameters
- error: EE
Returns AsyncData<ED, EE>
- Defined in src/AsyncData.ts:106

`Static` loaded

loaded<LD, LE>(data): AsyncData<LD, LE>
Create an instance of this type that indicates that some data has been returned by the request.

NB: There is nothing here that asserts that the request is complete. This factory method can be called multiple times to indicate loading data in progress.
Type Parameters
- LD
- LE = {}
Parameters
- data: readonly LD[]
Returns AsyncData<LD, LE>
- Defined in src/AsyncData.ts:95

`Static` loadedSingle

loadedSingle<LD, LE>(data): AsyncData<LD, LE>
Create an instance of this type that indicates that a single value has been returned.
Type Parameters
- LD
- LE = {}
Parameters
- data: LD
Returns AsyncData<LD, LE>
- Defined in src/AsyncData.ts:80

`Static` loading

loading<LD, LE>(): AsyncData<LD, LE>
Create an instance of this type that indicates that a request is in flight but has not yet completed
Type Parameters
- LD
- LE = {}
Returns AsyncData<LD, LE>
- Defined in src/AsyncData.ts:69

`Static` notAsked

notAsked<ND, NE>(): AsyncData<ND, NE>
Create an instance of this type that indicates that the request for async data has not yet been made
Type Parameters
- ND
- NE = {}
Returns AsyncData<ND, NE>
- Defined in src/AsyncData.ts:59

Class AsyncData<D, E>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

Private constructor

Type Parameters

Parameters

Optional data?: readonly D[]

Optional error?: E

status: RemoteDataStatus

Returns AsyncData<D, E>

Properties

Private Readonly internal

Protected status

Methods

all

Parameters

Parameters

Returns boolean

Returns boolean

Throws

any

Parameters

Parameters

Returns boolean

Returns boolean

Throws

append

Parameters

Returns AsyncData<D, {}>

Private cloneWithNewData

Type Parameters

Parameters

Returns AsyncData<U, E>

concat

Parameters

Returns AsyncData<D, E>

containsData

Returns boolean

every

Parameters

Parameters

Returns boolean

Returns boolean

Throws

filter

Parameters

Parameters

Returns boolean

Returns AsyncData<D, E>

find

Parameters

Parameters

Returns boolean

Returns undefined | D

findIndex

Parameters

Parameters

Returns boolean

Returns number

get

Parameters

Returns D

getAllOptional

Returns Optional<readonly D[]>

Private getNonLoadedResult

Type Parameters

Returns undefined | AsyncData<U, E>

getOptional

Returns Optional<D>

is

Parameters

Returns boolean

Private isArray

Parameters

Returns v is readonly D[]

isAsked

`Private` constructor

`Optional` data?: readonly D[]

`Optional` error?: E

`Private` `Readonly` internal

`Protected` status

`Private` cloneWithNewData

`Private` getNonLoadedResult

`Private` isArray

`Static` errored

`Static` loaded

`Static` loadedSingle

`Static` loading