Class APIListUsers

all

cut

root

first

• get first(): string | number

• Get first element of the stack

  Returns string | number

last

• get last(): string | number

• Get last element of the stack

  Returns string | number
• set last(val: string | number): void

• Set last element of the stack

  Parameters

  • val: string | number

  Returns void

abortRequest

• abortRequest(): void

• Returns void

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

create

• create(data: UserData): Promise<AxiosResponse<User>>

• Shortcut for sending data POST

  Parameters

  • data: UserData

  Returns Promise<AxiosResponse<User>>

data

• data(data: UserData): this

• Set data

  Parameters

  • data: UserData

  Returns this

delete

• delete(): this

• Set DELETE as HTTP method

  Returns this

filter

• filter(filter: string | FilterBuilder): this

• Sets filter

  Parameters

  • filter: string | FilterBuilder

    Filter

  Returns this

  this

formData

• formData(data: UserData): this

• Set form data

  Parameters

  • data: UserData

  Returns this

get

• get(): this

• Set GET as HTTP method

  Returns this

getLimit

• getLimit(): number

• Gets limit

  Returns number

  number

getParams

• getParams(): Partial<NoQueryParams>

• Returns Partial<NoQueryParams>

headers

• headers(headers: Record<string, string>): this

• Parameters

  • headers: Record<string, string>

  Returns this

jsonData

• jsonData(data: UserData): this

• Set JSON data

  Parameters

  • data: UserData

  Returns this

limit

• limit(limit?: number): this

• Sets limit

  Parameters

  • Optionallimit: number = DEFAULT_LIMIT

    Limit to be set

  Returns this

  this

method

• method(name: Method): this

• Set HTTP method

  Parameters

  • name: Method

  Returns this

noLimit

• noLimit(): this

• Disables limit

  Returns this

  this

offset

• offset(offset?: number): this

• Sets offset

  Parameters

  • Optionaloffset: number = DEFAULT_OFFSET

    Offset to be set

  Returns this

  this

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

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

params

• params<T extends string | number | symbol = string | number | symbol>(
      params: Pick<NoQueryParams, T>,
  ): this

• Set params

  Type Parameters

  • T extends string | number | symbol = string | number | symbol

  Parameters

  • params: Pick<NoQueryParams, T>

  Returns this

post

• post(): this

• Set POST as HTTP method

  Returns this

push

• push(...items: (string | number)[]): this

• Parameters

  • ...items: (string | number)[]

  Returns this

removeParam

• removeParam(key: string | number | symbol): this

• Parameters

  • key: string | number | symbol

  Returns this

removeRequestConfig

• removeRequestConfig(key: keyof AxiosRequestConfig): this

• Parameters

  • key: keyof AxiosRequestConfig

  Returns this

restack

• restack(...items: (string | number)[]): this

• Parameters

  • ...items: (string | number)[]

  Returns this

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

send

• send<T = CollectionResponse<User> | SimpleCollectionResponse<User>>(): Promise<
      AxiosResponse<T>,
  >

• Send request

  Type Parameters

  • T = CollectionResponse<User> | SimpleCollectionResponse<User>

  Returns Promise<AxiosResponse<T>>

setRequestConfig

• setRequestConfig(requestConfig: AxiosRequestConfig): this

• Parameters

  • requestConfig: AxiosRequestConfig

  Returns this

shift

• shift(): this

• Returns this

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

toUrl

• toUrl(absolute?: boolean): string

• Parameters

  • absolute: boolean = false

  Returns string