WarmHubClientOptions

Options for constructing a WarmHubClient.

Properties

apiUrl?

optional apiUrl?: string

Override the WarmHub API URL. Defaults to the public WarmHub API.

---

fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Custom fetch implementation for non-standard runtimes or tests.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

accessToken?

optional accessToken?: AccessTokenProvider

Static token or sync/async token provider used for authenticated requests.

---

auth?

optional auth?: object

Authentication provider object. Prefer auth.getToken when integrating with an existing session system.

getToken

getToken: () => Promise<string | undefined>

Returns

Promise<string | undefined>

---

functionLogs?

optional functionLogs?: FunctionLogMode

Control replay of backend function log lines. Defaults to off.

---

client?

optional client?: object

Self-identification sent on the X-WarmHub-Client header (name/version) for backend observability, compatibility admission, and read-analytics surface attribution. Defaults to @warmhub/sdk-ts/<SDK_VERSION>. A wrapper such as the WarmHub CLI overrides both values to identify its actual released artifact. An untrusted safety hint — never an authz signal. A per-request X-WarmHub-Client header on a raw request still wins over this default.

name?

optional name?: string

version?

optional version?: string

---

clientFlags?

optional clientFlags?: readonly string[]

Client-declared opt-in flags sent on X-WarmHub-Client-Flags. Flag names are defined by the backend deployment; see your deployment’s documentation. Grammar-checked here; validated and honored only by the server. Untrusted intent — never an authz signal.