Class WebApi

HTTP client with NoSpamProxy-specific authentication and retry-pipeline.

Hierarchy (View Summary)

WebApi
- OData

Implements

IDisposable

Index

Constructors

Properties

configManager httpClient responseCache

Methods

callFetch configureHttpClient delete dispose download get getBaseUrl handleNonOkResponse patch post put

Constructors

constructor

new WebApi(): WebApi
Returns WebApi
- Defined in core/src/services/WebApi.ts:39

Properties

`Protected`configManager

configManager: IConfigurationManager = ...

`Internal`httpClient

httpClient: IHttpClient

`Internal`responseCache

responseCache: Map<
string,
{ originalPromise: Promise<any>; responseValue?: any },
> = ...

In memory cache (short-lived storage)

Methods

callFetch

callFetch(callOptions: Partial<RemoteCallOptions>): Promise<any>
Parameters
- callOptions: Partial<RemoteCallOptions>
Returns Promise<any>
- Defined in core/src/services/WebApi.ts:75

`Protected`configureHttpClient

configureHttpClient(): void
Configures the HttpClient with base url, default header, interceptors etc. Extension point for the child classes to alter the configuration for HttpClient.

Returns void
- Defined in core/src/services/WebApi.ts:206

delete

delete(
apiUrl: string,
cancellationOptions?: RemoteCallCancellationOptions,
): Promise<any>
Parameters
- apiUrl: string
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<any>
- Defined in core/src/services/WebApi.ts:67

dispose

dispose(): void
Returns void
Implementation of IDisposable.dispose
- Defined in core/src/services/WebApi.ts:46

download

download(
__namedParameters: Partial<DownloadOptions>,
): Promise<{ blob: Blob; headers: Headers }>
Parameters
- __namedParameters: Partial<DownloadOptions>
Returns Promise<{ blob: Blob; headers: Headers }>
- Defined in core/src/services/WebApi.ts:71

get

get<T = any>(__namedParameters: Partial<RemoteGetOptions>): Promise<T>
Type Parameters
- T = any
Parameters
- __namedParameters: Partial<RemoteGetOptions>
Returns Promise<T>
- Defined in core/src/services/WebApi.ts:51

getBaseUrl

getBaseUrl(): string
Returns string
- Defined in core/src/services/WebApi.ts:235

`Protected`handleNonOkResponse

handleNonOkResponse(
_error: RemoteCallError,
_callOptions: Partial<RemoteCallOptions>,
): Promise<any> | null
Parameters
- _error: RemoteCallError
- _callOptions: Partial<RemoteCallOptions>
Returns Promise<any> | null
- Defined in core/src/services/WebApi.ts:263

patch

patch(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
- Defined in core/src/services/WebApi.ts:59

post

post(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
- Defined in core/src/services/WebApi.ts:55

put

put(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
- Defined in core/src/services/WebApi.ts:63