Class AdminClient

Hierarchy

BaseApiClient<IAdminApiClientConfig>
- AdminClient

Index

Constructors

Properties

axios config log

Accessors

axiosInstance domain meta

Methods

isJsonMime setHeader waitUntilHealthy

Constructors

constructor

new AdminClient(config: IAdminApiClientConfig): AdminClient
Parameters
- config: IAdminApiClientConfig
Returns AdminClient
Overrides BaseApiClient<IAdminApiClientConfig>.constructor
- Defined in packages/lib-apiclient/src/lib/adminClient.ts:12

Properties

`Protected`axios

axios: AxiosInstance

`Protected` `Readonly`config

config: IAdminApiClientConfig

`Protected`log

log: Logger = ...

Accessors

axiosInstance

get axiosInstance(): AxiosInstance
Returns AxiosInstance
Inherited from BaseApiClient.axiosInstance
- Defined in packages/lib-apiclient/src/lib/baseClient.ts:43

domain

get domain(): DomainApi
Returns DomainApi
- Defined in packages/lib-apiclient/src/lib/adminClient.ts:28

meta

get meta(): MetaApi
Returns MetaApi
Inherited from BaseApiClient.meta
- Defined in packages/lib-apiclient/src/lib/baseClient.ts:140

Methods

isJsonMime

isJsonMime(mime: string): mime is "application/json"
Parameters
- mime: string
Returns mime is "application/json"
Inherited from BaseApiClient.isJsonMime
- Defined in packages/lib-apiclient/src/lib/baseClient.ts:47

setHeader

setHeader(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
Inherited from BaseApiClient.setHeader
- Defined in packages/lib-apiclient/src/lib/baseClient.ts:39

waitUntilHealthy

waitUntilHealthy(timeout?: number): Promise<void>
Wait until the API reports that it is healthy
Parameters
- timeout: number = 600000
  in milliseconds
Returns Promise<void>
Inherited from BaseApiClient.waitUntilHealthy
- Defined in packages/lib-apiclient/src/lib/baseClient.ts:119