Class ApiClient

HTTP client wrapping fetch with a base URL and bearer-token authentication, used by every Teia REST API client to build requests and parse JSON responses.

Index

Constructors

Accessors

baseUrl instanceToken token

Methods

sendRequest URL

Constructors

constructor

new ApiClient(
    baseUrl?: string,
    token?: string,
    instanceToken?: string,
): ApiClient
Parameters
- baseUrl: string = ''
- token: string = ''
- instanceToken: string = ''
Returns ApiClient
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:12

Accessors

baseUrl

get baseUrl(): string
Returns string
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:18
set baseUrl(value: string): void
Parameters
- value: string
Returns void
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:22

instanceToken

get instanceToken(): string
Returns string
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:26
set instanceToken(value: string): void
Parameters
- value: string
Returns void
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:30

token

get token(): string
Returns string
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:34
set token(value: string): void
Parameters
- value: string
Returns void
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:38

Methods

sendRequest

sendRequest<T = void>(request: Request): Promise<T>
Sends the given request using the fetch API.

Note: Content-Type:text is used by default for PUT, POST and PATCH if not specified
Type Parameters
- T = void
Parameters
- request: Request
Returns Promise<T>
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:58

URL

URL(endpoint: string): URL
Creates a new URL from the endpoint and base url.
Parameters
- endpoint: string
Returns URL
- Defined in plugins/src/TeiaPlugin/api/common/ApiClient.ts:47