Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Api<GlobalResponseData>

API class that supports the app's store instance

Type parameters

  • GlobalResponseData: Data

Hierarchy

Index

Accessors

Methods

Accessors

Protected axiosConfig

  • get axiosConfig(): AxiosRequestConfig

Methods

Protected getCsrfToken

  • getCsrfToken(): string | null

Protected onConnection

  • onConnection(has: boolean): void

Protected onGlobalResponse

Protected promiseHttpErrorReject

  • promiseHttpErrorReject(reject: function): function

  • Return a reject function for an HTTP error.

    Parameters

    • reject: function

    Returns function

      • (error: AxiosError): void

      • Parameters

        • error: AxiosError

        Returns void

Protected rejectApiError

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

requestByURL

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

  • Type parameters

    • ResponseData: Data

    Parameters

    • url: string

      API endpoint URL

    • Optional formData: FormData

    Returns Promise<ResponseData>

requestComposite

requestPaginated

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

  • 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

requestSingle

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

  • 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

Generated using TypeDoc