Class ApiClient

Hierarchy (View Summary)

HttpClient<ApiClientOptions>
- ApiClient

Implements

IApiClient

Index

Constructors

Properties

Methods

delete get getUrl head patch post put request

Constructors

constructor

new ApiClient(
    _session?: null | ISession,
    extensionContainer?: null | IExtensionContainer,
    hooksProvider?: null | IHttpInterceptorHooksProvider<HttpOptions>,
): ApiClient
Parameters
- _session: null | ISession = null
- extensionContainer: null | IExtensionContainer = null
- hooksProvider: null | IHttpInterceptorHooksProvider<HttpOptions> = null
Returns ApiClient
Overrides HttpClient.constructor
- Defined in @tessa/application/src/http/api/apiClient.ts:19

Properties

defaultHooks

defaultHooks: Partial<
Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>,
>[]

Methods

delete

delete(
url: HttpInput,
options?: WithHeadersInit<ApiClientOptions>,
): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.delete
Inherited from HttpClient.delete
- Defined in @tessa/application/src/http/httpClient.ts:441

get

get(url: HttpInput, options?: WithHeadersInit<ApiClientOptions>): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.get
Inherited from HttpClient.get
- Defined in @tessa/application/src/http/httpClient.ts:421

getUrl

getUrl(
url: HttpInput,
options?: WithHeadersInit<ApiClientOptions>,
): Promise<string>
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns Promise<string>
Implementation of IApiClient.getUrl
Inherited from HttpClient.getUrl
- Defined in @tessa/application/src/http/httpClient.ts:445

head

head(url: HttpInput, options?: WithHeadersInit<ApiClientOptions>): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.head
Inherited from HttpClient.head
- Defined in @tessa/application/src/http/httpClient.ts:437

patch

patch(
url: HttpInput,
options?: WithHeadersInit<ApiClientOptions>,
): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.patch
Inherited from HttpClient.patch
- Defined in @tessa/application/src/http/httpClient.ts:433

post

post(url: HttpInput, options?: WithHeadersInit<ApiClientOptions>): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.post
Inherited from HttpClient.post
- Defined in @tessa/application/src/http/httpClient.ts:425

put

put(url: HttpInput, options?: WithHeadersInit<ApiClientOptions>): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.put
Inherited from HttpClient.put
- Defined in @tessa/application/src/http/httpClient.ts:429

request

request(
url: HttpInput,
options?: WithHeadersInit<ApiClientOptions>,
): IHttpExecutor
Parameters
- url: HttpInput
- Optionaloptions: WithHeadersInit<ApiClientOptions>
Returns IHttpExecutor
Implementation of IApiClient.request
Inherited from HttpClient.request
- Defined in @tessa/application/src/http/httpClient.ts:417