Class HttpClient<SecurityDataType>

Type Parameters

SecurityDataType = unknown

Hierarchy (View Summary)

HttpClient
- UserDataClient

Index

Constructors

Properties

Methods

abortRequest addArrayQueryParam addQueryParam addQueryParams createAbortSignal encodeQueryParam mergeRequestParams request setSecurityData toQueryString

Constructors

constructor

new HttpClient<SecurityDataType = unknown>(
apiConfig?: ApiConfig<SecurityDataType>,
): HttpClient<SecurityDataType>
Type Parameters
- SecurityDataType = unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns HttpClient<SecurityDataType>
- Defined in packages/user-data-client/src/userdata.ts:167

Properties

baseUrl

baseUrl: string = ""

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
- Defined in packages/user-data-client/src/userdata.ts:274

`Protected`addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
- Defined in packages/user-data-client/src/userdata.ts:184

`Protected`addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
- Defined in packages/user-data-client/src/userdata.ts:180

`Protected`addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
- Defined in packages/user-data-client/src/userdata.ts:203

`Protected`createAbortSignal

createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined
Parameters
- cancelToken: CancelToken
Returns AbortSignal | undefined
- Defined in packages/user-data-client/src/userdata.ts:258

`Protected`encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
- Defined in packages/user-data-client/src/userdata.ts:175

`Protected`mergeRequestParams

mergeRequestParams(
params1: RequestParams,
params2?: RequestParams,
): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
- Defined in packages/user-data-client/src/userdata.ts:242

request

request<T = any, E = any>(
__namedParameters: FullRequestParams,
): Promise<HttpResponse<T, E>>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<HttpResponse<T, E>>
- Defined in packages/user-data-client/src/userdata.ts:283

setSecurityData

setSecurityData(data: SecurityDataType | null): void
Parameters
- data: SecurityDataType | null
Returns void
- Defined in packages/user-data-client/src/userdata.ts:171

`Protected`toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
- Defined in packages/user-data-client/src/userdata.ts:189