Interface: ApiContextType

This is the interface/type of the ApiContext.

Properties

apiClient: AxiosInstance

Axios client for RESTful services

authenticated: boolean

true if the ApiContextProvider has established an authenticated session

authenticated_user: null | User

the current user state if the ApiContextProvider has established an authenticated session

autoSignOut: null | () => void

a function that can be called to terminate the current session (if using authentication)

baseURL: string

Base URL for RESTful service

data: any

read-only data store

setData: (newData) => void

setter to update data store

any

void

token: null | JWT

id token retrieved from Cognito which is used in requests made by the apiClient (if using authentication)