1.0.X

API Reference for Axios

init(refreshTokenUrl, sessionExpiredStatusCode?, refreshAPICustomHeaders?)

Parameters

  • refreshTokenUrl
    • Type: string
    • Should be the full request URL for your refresh session API endpoint.
    • This function will send a POST request to it.
  • sessionExpiredStatusCode (Optional)
    • Type: number
    • Default: 440
    • HTTP status code that indicates session expiry - as sent by your APIs.
  • refreshAPICustomHeaders (Optional)
    • Type: object
    • Default: {}
    • If your refresh API requires any custom headers (for example a version number), then you can provide that in this object. An example is: {api-version: "0"}

Returns

  • void

Throws

  • Nothing

makeSuper(axios)

Parameters

  • axios instance

Returns

  • void

Throws

  • Nothing

axios(data, config?)

Parameters

  • data
    • Type: string or object
    • Same as what axios() expects. Either the string url or the config used to make the API call.
  • config (Optional)
    • Type: object
    • Same as what axios() expects. Config object used to make the API call.

Returns

  • Identical to the axios API.

Throws

  • Identical to the axios API.
  • An Error object if the init function is not called.

get(data, config?) post(data, config?) delete(data, config?) put(data, config?)

Parameters

  • data
    • Type: string or object
    • Same as what axios() expects. Either the string url or the config used to make the API call.
  • config (Optional)
    • Type: object
    • Same as what axios() expects. Config object used to make the API call.

Returns

  • Identical to the axios API.

Throws

  • Identical to the axios API.
  • An Error object if the init function is not called.

doesSessionExist()

Parameters

  • None

Returns

  • Promise<boolean>

Throws

  • Nothing
← Fetch