Class APIList<RESPONSE, QUERY_PARAMS, DATA>

Type Parameters

RESPONSE = any
HTTP Response return type.
QUERY_PARAMS extends CollectionBasicQueryParams | CollectionQueryParams | NoQueryParams = CollectionQueryParams
Allowed Query Params
DATA = any
Allowed Data Object

Index

Constructors

Properties

abortController all ALLOWED_HTTP_METHODS cut requestConfig root stack

Accessors

Constructors

constructor

new APIList<
    RESPONSE = any,
    QUERY_PARAMS extends
        CollectionQueryParams | CollectionBasicQueryParams | NoQueryParams = CollectionQueryParams,
    DATA = any,
>(
    parent?:
        | API
        | APIEntity<
            CollectionResponse<RESPONSE>
            | SimpleCollectionResponse<RESPONSE>,
        >,
): APIList<RESPONSE, QUERY_PARAMS, DATA>
Constructor
Type Parameters
- RESPONSE = any
- QUERY_PARAMS extends CollectionQueryParams | CollectionBasicQueryParams | NoQueryParams = CollectionQueryParams
- DATA = any
Parameters
- Optionalparent:
      | API
      | APIEntity<
          CollectionResponse<RESPONSE>
          | SimpleCollectionResponse<RESPONSE>,
      >
  Specifies a parent from which should be inherited properties
Returns APIList<RESPONSE, QUERY_PARAMS, DATA>
Inherited from APIEntity.constructor
- Defined in api/APIEntity.ts:26

Properties

`Protected`abortController

abortController: AbortController

all

all: () => this = ...

Alias for 'noLimit'

Type declaration

- (): this
- Disables limit
  
  Returns this
  this

See

noLimit

Returns

this

`Protected`ALLOWED_HTTP_METHODS

ALLOWED_HTTP_METHODS: Method[] = ALLOWED_HTTP_METHODS

cut

cut: (from: number, to: number) => this = ...

Alias for 'between'

Type declaration

- (from: number, to: number): this
- Sets limit and offset so that will request from BE records between range
  Parameters
  - from: number
    From index
  - to: number
    To index
  Returns this
  this

Param: from

From idx

Param: to

To idx

Returns

this

`Protected`requestConfig

requestConfig: AxiosRequestConfig = {}

root

root: API

`Protected`stack

stack: (string | number)[] = []

Accessors

first

get first(): string | number
Get first element of the stack

Returns string | number
Inherited from APIEntity.first
- Defined in api/APIEntity.ts:66

last

get last(): string | number
Get last element of the stack

Returns string | number
Inherited from APIEntity.last
- Defined in api/APIEntity.ts:73
set last(val: string | number): void
Set last element of the stack
Parameters
- val: string | number
Returns void
Inherited from APIEntity.last
- Defined in api/APIEntity.ts:80

Methods

abortRequest

abortRequest(): void
Returns void
Inherited from APIEntity.abortRequest
- Defined in api/APIEntity.ts:43

between

between(from: number, to: number): this
Sets limit and offset so that will request from BE records between range
Parameters
- from: number
  From index
- to: number
  To index
Returns this
this
- Defined in api/APIList.ts:96

create

create(data: DATA): Promise<AxiosResponse<RESPONSE>>
Shortcut for sending data POST
Parameters
- data: DATA
Returns Promise<AxiosResponse<RESPONSE>>
- Defined in api/APIList.ts:16

data

data(data: DATA): this
Set data
Parameters
- data: DATA
Returns this
Inherited from APIEntity.data
- Defined in api/APIEntity.ts:175

delete

delete(): this
Set DELETE as HTTP method

Returns this
Inherited from APIEntity.delete
- Defined in api/APIEntity.ts:151

filter

filter(filter: string | FilterBuilder): this
Sets filter
Parameters
- filter: string | FilterBuilder
  Filter
Returns this
this
- Defined in api/APIList.ts:177

formData

formData(data: DATA): this
Set form data
Parameters
- data: DATA
Returns this
Inherited from APIEntity.formData
- Defined in api/APIEntity.ts:193

get

get(): this
Set GET as HTTP method

Returns this
Inherited from APIEntity.get
- Defined in api/APIEntity.ts:137

getLimit

getLimit(): number
Gets limit

Returns number
number
- Defined in api/APIList.ts:56

getParams

getParams(): Partial<QUERY_PARAMS>
Returns Partial<QUERY_PARAMS>
Inherited from APIEntity.getParams
- Defined in api/APIEntity.ts:163

headers

headers(headers: Record<string, string>): this
Parameters
- headers: Record<string, string>
Returns this
Inherited from APIEntity.headers
- Defined in api/APIEntity.ts:104

jsonData

jsonData(data: DATA): this
Set JSON data
Parameters
- data: DATA
Returns this
Inherited from APIEntity.jsonData
- Defined in api/APIEntity.ts:183

limit

limit(limit?: number): this
Sets limit
Parameters
- Optionallimit: number = DEFAULT_LIMIT
  Limit to be set
Returns this
this
- Defined in api/APIList.ts:40

method

method(name: Method): this
Set HTTP method
Parameters
- name: Method
Returns this
Inherited from APIEntity.method
- Defined in api/APIEntity.ts:121

noLimit

noLimit(): this
Disables limit

Returns this
this
- Defined in api/APIList.ts:67

offset

offset(offset?: number): this
Sets offset
Parameters
- Optionaloffset: number = DEFAULT_OFFSET
  Offset to be set
Returns this
this
- Defined in api/APIList.ts:78

only

only(idx: number): this
Sets limit and offset so that will request from BE one record on given index
Parameters
- idx: number
  Index
Returns this
this
- Defined in api/APIList.ts:118

page

page(page?: number): this
Gets current limit and sets offset so that will request from BE one page of records
Parameters
- Optionalpage: number = 1
  Page number (counted from 1)
Returns this
this
- Defined in api/APIList.ts:136

params

params<T extends string | number | symbol = keyof QUERY_PARAMS>(
params: Pick<QUERY_PARAMS, T>,
): this
Set params
Type Parameters
- T extends string | number | symbol = keyof QUERY_PARAMS
Parameters
- params: Pick<QUERY_PARAMS, T>
Returns this
Inherited from APIEntity.params
- Defined in api/APIEntity.ts:158

`Protected`paramsSerializer

paramsSerializer(params: QUERY_PARAMS | DATA): string
Parameters
- params: QUERY_PARAMS | DATA
Returns string
Inherited from APIEntity.paramsSerializer
- Defined in api/APIEntity.ts:234

post

post(): this
Set POST as HTTP method

Returns this
Inherited from APIEntity.post
- Defined in api/APIEntity.ts:144

push

push(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Inherited from APIEntity.push
- Defined in api/APIEntity.ts:48

removeParam

removeParam(key: keyof QUERY_PARAMS): this
Parameters
- key: keyof QUERY_PARAMS
Returns this
Inherited from APIEntity.removeParam
- Defined in api/APIEntity.ts:167

removeRequestConfig

removeRequestConfig(key: keyof AxiosRequestConfig): this
Parameters
- key: keyof AxiosRequestConfig
Returns this
Inherited from APIEntity.removeRequestConfig
- Defined in api/APIEntity.ts:99

restack

restack(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Inherited from APIEntity.restack
- Defined in api/APIEntity.ts:58

search

search(query: string): this
Sets search

query param is working like SQL LIKE. BE sets wraps around query with %, and replaces every white character with %. So e.g. if query='my device', then it's searching for '%my%device%' in DB.
Parameters
- query: string
  Query to search for
Returns this
this
- Defined in api/APIList.ts:160

send

send<T = CollectionResponse<RESPONSE> | SimpleCollectionResponse<RESPONSE>>(): Promise<
AxiosResponse<T>,
>
Send request
Type Parameters
- T = CollectionResponse<RESPONSE> | SimpleCollectionResponse<RESPONSE>
Returns Promise<AxiosResponse<T>>
Inherited from APIEntity.send
- Defined in api/APIEntity.ts:203

setRequestConfig

setRequestConfig(requestConfig: AxiosRequestConfig): this
Parameters
- requestConfig: AxiosRequestConfig
Returns this
Inherited from APIEntity.setRequestConfig
- Defined in api/APIEntity.ts:94

shift

shift(): this
Returns this
Inherited from APIEntity.shift
- Defined in api/APIEntity.ts:53

sort

sort(name: string, order?: APIOrder): this
Sets sorting
Parameters
- name: string
  Name of the column according to which the data will be sorted
- Optionalorder: APIOrder = APIOrder.asc
  Sorting order. Possibilities: 'a', 'd'
Returns this
- Defined in api/APIList.ts:27

toUrl

toUrl(absolute?: boolean): string
Parameters
- absolute: boolean = false
Returns string
Inherited from APIEntity.toUrl
- Defined in api/APIEntity.ts:84