Class BaseClient

Hierarchy (view full)

BaseClient

Implements

Client

Index

Constructors

Properties

config instance

Methods

buildErrorHandlingResponse encode handleFailedResponse handleSuccessResponse paramSerializer removeUndefinedProperties sendRequest sendRequestFullResponse

Constructors

constructor

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

Properties

`Protected` `Readonly` config

config: Config

`Private` instance

instance: AxiosInstance

Methods

`Private` buildErrorHandlingResponse

buildErrorHandlingResponse(error): any
Parameters
- error: AxiosError<any, any>
Returns any
- Defined in clients/baseClient.ts:135

`Protected` encode

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

handleFailedResponse

handleFailedResponse<T>(e, callback?): void
Type Parameters
- T
Parameters
- e: Error
- Optional callback: Callback<T>
Returns void
Implementation of Client.handleFailedResponse
- Defined in clients/baseClient.ts:120

handleSuccessResponse

handleSuccessResponse<T>(response, callback?): void | T
Type Parameters
- T
Parameters
- response: any
- Optional callback: Callback<T>
Returns void | T
Implementation of Client.handleSuccessResponse
- Defined in clients/baseClient.ts:109

`Protected` paramSerializer

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

`Protected` removeUndefinedProperties

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

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:85
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:86

sendRequestFullResponse

sendRequestFullResponse<T>(requestConfig): Promise<AxiosResponse<T, any>>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
Returns Promise<AxiosResponse<T, any>>
Implementation of Client.sendRequestFullResponse
- Defined in clients/baseClient.ts:97

Generated using TypeDoc v0.25.9