Class BaseClient

Hierarchy (view full)

BaseClient
- ConfluenceClient
- ServerClient

Implements

Client

Index

Constructors

Properties

#instance config

Accessors

Methods

encode paramSerializer removeUndefinedProperties sendRequest

Constructors

constructor

new BaseClient(config): BaseClient
Parameters
- config: Config
Returns BaseClient
- Defined in clients/baseClient.ts:14

Properties

`Private` #instance

#instance: undefined | AxiosInstance

`Protected` `Readonly` config

config: Config

Accessors

`Private` instance

get instance(): AxiosInstance
Returns AxiosInstance
- Defined in clients/baseClient.ts:66

Methods

`Protected` encode

encode(value): string
Parameters
- value: string
Returns string
- Defined in clients/baseClient.ts:50

`Protected` paramSerializer

paramSerializer(parameters): string
Parameters
- parameters: Record<string, any>
Returns string
- Defined in clients/baseClient.ts:18

`Protected` removeUndefinedProperties

removeUndefinedProperties(obj): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
- Defined in clients/baseClient.ts:60

sendRequest

sendRequest<T>(requestConfig, callback, telemetryData?): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
- Optional telemetryData: any
Returns Promise<T>
Implementation of Client.sendRequest
- Defined in clients/baseClient.ts:86
sendRequest<T>(requestConfig, callback, telemetryData?): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
- Optional telemetryData: any
Returns Promise<void>
Implementation of Client.sendRequest
- Defined in clients/baseClient.ts:87

Generated using TypeDoc v0.25.12