Class Api<GlobalResponseData>

Type parameters

GlobalResponseData: Data

Hierarchy

Api
- Api

Index

Accessors

axiosConfig

Methods

Accessors

Protected axiosConfig

get axiosConfig(): AxiosRequestConfig

- Defined in lib/api.ts:69
Returns AxiosRequestConfig

Methods

Protected Abstract getCsrfToken

getCsrfToken(): string | null

- Defined in lib/api.ts:62
Function that returns current CSRF token.

Returns string | null

Protected Abstract onConnection

onConnection(has: boolean): void

- Defined in lib/api.ts:57
Function that gets called when the API loses or regains internet connection.

Parameters
- has: boolean
Returns void

Protected Abstract onGlobalResponse

onGlobalResponse(data: GlobalResponseData): void

- Defined in lib/api.ts:67
function that gets called once new global request response is available.

Parameters
- data: GlobalResponseData
Returns void

Protected promiseHttpErrorReject

promiseHttpErrorReject(reject: function): function

- Defined in lib/api.ts:89
Return a reject function for an HTTP error.

Parameters
- reject: function
  - - (error: ApiError): void
    - Parameters
      - error: ApiError
      Returns void
Returns function
- - (error: AxiosError): void
  - Parameters
    - error: AxiosError
    Returns void

Protected rejectApiError

rejectApiError(reject: function, error: ApiError): void

- Defined in lib/api.ts:103
Reject function an API error.

Parameters
- reject: function
  - - (error: ApiError): void
    - Parameters
      - error: ApiError
      Returns void
- error: ApiError
Returns void

requestByURL

requestByURL<ResponseData>(url: string, formData?: FormData): Promise<ResponseData>

- Defined in lib/api.ts:202
Type parameters
- ResponseData: Data
Parameters
- url: string
  
  API endpoint URL
- Optional formData: FormData
Returns Promise<ResponseData>

requestComposite

requestComposite<ResponseData>(allParams: MatchingData<ResponseData>, includeGlobal?: boolean): Promise<RawCompositeApiResponse<ResponseData>>

- Defined in lib/api.ts:123
Perform a composite API call.

Type parameters
- ResponseData: Data
Parameters
- allParams: MatchingData<ResponseData>
  
  Parameters of all requests
- Default value includeGlobal: boolean = true
  
  Whether the 'global' request should be included
Returns Promise<RawCompositeApiResponse<ResponseData>>

requestPaginated

requestPaginated<ResponseData, OriginalResponseData>(url: string, modifyDataCallback?: undefined | function): function

- Defined in lib/api.ts:245
Request to an endpoint that returns a paginated response. Next results can be easily requested.

Type parameters
- ResponseData: Data[]
- OriginalResponseData: Data[]
Parameters
- url: string
- Optional modifyDataCallback: undefined | function
Returns function
- - (): Promise<ContinuousResponse<ResponseData>>
  - Returns Promise<ContinuousResponse<ResponseData>>

requestSingle

requestSingle<ResponseData>(name: string, params?: Data | FormData, includeGlobal?: boolean): Promise<ResponseData>

- Defined in lib/api.ts:162
Perform an API call.

Type parameters
- ResponseData: Data
Parameters
- name: string
  
  Request name
- Default value params: Data | FormData = {}
  
  Request parameters
- Default value includeGlobal: boolean = true
  
  Whether the 'global' request should be included
Returns Promise<ResponseData>

Protected responseIncludesGlobal

responseIncludesGlobal<ResponseData>(data: RawCompositeApiResponse<ResponseData>): boolean

- Defined in lib/api.ts:112
Type parameters
- ResponseData: Data
Parameters
- data: RawCompositeApiResponse<ResponseData>
Returns boolean

Generated using TypeDoc