Class RestDatasource<T>

Very small lazy REST datasource.

It requests pages from: ${baseUrl}?pageIndex=<n>&pageSize=<size> and caches each page in memory after the first request.

Type Parameters

T

Implements

IDatasource<T>

Index

Constructors

Methods

getNumberOfItems getObjectAtRowIndex

Constructors

constructor

new RestDatasource<T>(
    baseUrl: string,
    pageSize?: number,
    fetchFn?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    },
): RestDatasource<T>
Type Parameters
- T
Parameters
- baseUrl: string
- pageSize: number = DEFAULT_PAGE_SIZE
- fetchFn: {
  (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
  (input: string | Request | URL, init?: RequestInit): Promise<Response>;
  } = defaultFetch
  - (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: RequestInfo | URL
    Optionalinit: RequestInit
    Returns Promise<Response>
    (input: string | Request | URL, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: string | Request | URL
    Optionalinit: RequestInit
    Returns Promise<Response>
Returns RestDatasource<T>
- Defined in packages/foundation/src/lib/datasources/rest-datasource.ts:26

Methods

getNumberOfItems

getNumberOfItems(): number | Promise<number>
Returns the total number of items, synchronously or asynchronously.

Returns number | Promise<number>
Implementation of IDatasource.getNumberOfItems
- Defined in packages/foundation/src/lib/datasources/rest-datasource.ts:36

getObjectAtRowIndex

getObjectAtRowIndex(rowIndex: number): RowResult<T>
Returns the row object at the given index.
Parameters
- rowIndex: number
  Zero-based index of the row to retrieve.
Returns RowResult<T>
The row value, or a Promise that resolves to it.
Implementation of IDatasource.getObjectAtRowIndex
- Defined in packages/foundation/src/lib/datasources/rest-datasource.ts:45