Class APIEntity<RESPONSE, QUERY_PARAMS, DATA>

constructor

• new APIEntity<
      RESPONSE = any,
      QUERY_PARAMS extends void | QueryParams = QueryParams,
      DATA = any,
  >(
      parent?: API | APIEntity<RESPONSE>,
  ): APIEntity<RESPONSE, QUERY_PARAMS, DATA>

• Constructor

  Type Parameters

  • RESPONSE = any
  • QUERY_PARAMS extends void | QueryParams = QueryParams
  • DATA = any

  Parameters

  • Optionalparent: API | APIEntity<RESPONSE>

    Specifies a parent from which should be inherited properties

  Returns APIEntity<RESPONSE, QUERY_PARAMS, DATA>

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

data

• data(data: DATA): this

• Set data

  Parameters

  • data: DATA

  Returns this

delete

• delete(): this

• Set DELETE as HTTP method

  Returns this

formData

• formData(data: DATA): this

• Set form data

  Parameters

  • data: DATA

  Returns this

get

• get(): this

• Set GET as HTTP method

  Returns this

getParams

• getParams(): Partial<QUERY_PARAMS>

• Returns Partial<QUERY_PARAMS>

headers

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

• Parameters

  • headers: Record<string, string>

  Returns this

jsonData

• jsonData(data: DATA): this

• Set JSON data

  Parameters

  • data: DATA

  Returns this

method

• method(name: Method): this

• Set HTTP method

  Parameters

  • name: Method

  Returns this

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

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: keyof QUERY_PARAMS): this

• Parameters

  • key: keyof QUERY_PARAMS

  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

send

• send<T = RESPONSE>(): Promise<AxiosResponse<T>>

• Send request

  Type Parameters

  • T = RESPONSE

  Returns Promise<AxiosResponse<T>>

setRequestConfig

• setRequestConfig(requestConfig: AxiosRequestConfig): this

• Parameters

  • requestConfig: AxiosRequestConfig

  Returns this

shift

• shift(): this

• Returns this

toUrl

• toUrl(absolute?: boolean): string

• Parameters

  • absolute: boolean = false

  Returns string