@terminaldz/zrexpress-sdk / index / ZrExpressOptions
Interface: ZrExpressOptions
Defined in: config.ts:26
Extended by
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
apiKey | string | X-Api-Key portal token. Required. Never logged or serialized. | config.ts:28 |
tenantId | string | X-Tenant GUID. Required (a handful of key/profile operations skip the header). | config.ts:30 |
baseUrl? | string | API origin (default https://api.zrexpress.app). | config.ts:32 |
apiVersion? | string | Path version segment (default '1' → /api/v1). | config.ts:34 |
timeoutMs? | number | Per-attempt timeout (default 30_000 ms). | config.ts:36 |
retry? | ZrRetryOptions | - | config.ts:37 |
fetch? | (input, init?) => Promise<Response> | Injectable fetch (tests / custom dispatchers). Defaults to global fetch. | config.ts:39 |
logger? | ZrLogger | Optional logger; silent by default. | config.ts:41 |
userAgent? | string | Appended to the built-in zrexpress-sdk/<version> node/<v> user agent. | config.ts:43 |