Class BaseClient`Abstract`

Abstract base HTTP client with retry logic and request/response transformation.

Hierarchy (View Summary)

BaseClient
- TelaSDK

Index

Constructors

Properties

baseURL fetch maxRetries timeout

Accessors

Methods

buildRequest buildURL createHeaders delete fetchWithTimeout get getAuthHeaders getUserAgent patch post put stringifyQuery

Constructors

constructor

new BaseClient(__namedParameters: BaseClientOptions): BaseClient
Parameters
- __namedParameters: BaseClientOptions
Returns BaseClient

Properties

baseURL

baseURL: string

fetch

fetch: typeof fetch

maxRetries

maxRetries: number

timeout

timeout: number

Accessors

`Abstract`authToken

get authToken(): string
Returns string

Methods

`Protected`buildRequest

buildRequest<Req>(
options: RequestOptions<Req>,
): { req: RequestInit; timeout: number; url: string }
Type Parameters
- Req
Parameters
- options: RequestOptions<Req>
Returns { req: RequestInit; timeout: number; url: string }

`Protected`buildURL

buildURL<Req>(path: string, query: Req | null | undefined): string
Type Parameters
- Req
Parameters
- path: string
- query: Req | null | undefined
Returns string

`Protected`createHeaders

createHeaders(opts?: Record<string, string>): Headers
Parameters
- Optionalopts: Record<string, string>
Returns Headers

delete

delete<Req, Res>(path: string, opts?: RequestOptions<Req>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- path: string
- Optionalopts: RequestOptions<Req>
Returns Promise<Res>

fetchWithTimeout

fetchWithTimeout(
    url: string,
    _options: RequestInit,
    timeout: number,
    controller: AbortController,
): Promise<Response>
Parameters
- url: string
- _options: RequestInit
- timeout: number
- controller: AbortController
Returns Promise<Response>

get

get<Req, Res>(path: string, opts?: RequestOptions<Req>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- path: string
- Optionalopts: RequestOptions<Req>
Returns Promise<Res>

`Protected` `Abstract`getAuthHeaders

getAuthHeaders(): Record<string, string>
Returns Record<string, string>

`Protected`getUserAgent

getUserAgent(): string
Returns string

patch

patch<Req, Res>(path: string, opts?: RequestOptions<Req>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- path: string
- Optionalopts: RequestOptions<Req>
Returns Promise<Res>

post

post<Req, Res>(path: string, opts?: RequestOptions<Req>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- path: string
- Optionalopts: RequestOptions<Req>
Returns Promise<Res>

put

put<Req, Res>(path: string, opts?: RequestOptions<Req>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- path: string
- Optionalopts: RequestOptions<Req>
Returns Promise<Res>

`Protected`stringifyQuery

stringifyQuery(query: Record<string, unknown>): string
Parameters
- query: Record<string, unknown>
Returns string