Class HttpClient<SecurityDataType>

Type Parameters

SecurityDataType = unknown

Hierarchy

HttpClient
- Api

Index

Constructors

Properties

abortControllers baseApiParams baseUrl contentFormatters securityData securityWorker

Methods

abortRequest addArrayQueryParam addQueryParam addQueryParams createAbortSignal customFetch encodeQueryParam mergeRequestParams request setSecurityData toQueryString

Constructors

constructor

new HttpClient<SecurityDataType>(apiConfig?: ApiConfig<SecurityDataType>): HttpClient<SecurityDataType>
Type Parameters
- SecurityDataType = unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns HttpClient<SecurityDataType>
- Defined in packages/client/src/api.ts:220

Properties

`Private` abortControllers

abortControllers: Map<CancelToken, AbortController> = ...

`Private` baseApiParams

baseApiParams: RequestParams = ...

baseUrl

baseUrl: string = 'http://localhost:7171/api'

`Private` contentFormatters

contentFormatters: Record<ContentType, ((input: any) => any)> = ...

`Private` securityData

securityData: null | SecurityDataType = null

`Private` `Optional` securityWorker

securityWorker?: ((securityData: null | SecurityDataType) => void | RequestParams | Promise<void | RequestParams>)

Type declaration

- (securityData: null | SecurityDataType): void | RequestParams | Promise<void | RequestParams>
- Parameters
  - securityData: null | SecurityDataType
  Returns void | RequestParams | Promise<void | RequestParams>

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
- Defined in packages/client/src/api.ts:301

`Private` addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
- Defined in packages/client/src/api.ts:237

`Private` addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
- Defined in packages/client/src/api.ts:233

`Protected` addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- Optional rawQuery: QueryParamsType
Returns string
- Defined in packages/client/src/api.ts:250

`Private` createAbortSignal

createAbortSignal(cancelToken: CancelToken): undefined | AbortSignal
Parameters
- cancelToken: CancelToken
Returns undefined | AbortSignal
- Defined in packages/client/src/api.ts:287

`Private` customFetch

customFetch(...fetchParams: [input: RequestInfo | URL, init?: RequestInit]): Promise<Response>
Parameters
- Rest ...fetchParams: [input: RequestInfo | URL, init?: RequestInit]
Returns Promise<Response>
- Defined in packages/client/src/api.ts:211

`Private` encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
- Defined in packages/client/src/api.ts:228

`Private` mergeRequestParams

mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams
Parameters
- params1: RequestParams
- Optional params2: RequestParams
Returns RequestParams
- Defined in packages/client/src/api.ts:274

request

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

setSecurityData

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

`Protected` toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- Optional rawQuery: QueryParamsType
Returns string
- Defined in packages/client/src/api.ts:242

Generated using TypeDoc