Skip to content

@terminaldz/zrexpress-sdk / index / ZrExpressOptions

Interface: ZrExpressOptions ​

Defined in: config.ts:26

Extended by ​

Properties ​

PropertyTypeDescriptionDefined in
apiKeystringX-Api-Key portal token. Required. Never logged or serialized.config.ts:28
tenantIdstringX-Tenant GUID. Required (a handful of key/profile operations skip the header).config.ts:30
baseUrl?stringAPI origin (default https://api.zrexpress.app).config.ts:32
apiVersion?stringPath version segment (default '1' → /api/v1).config.ts:34
timeoutMs?numberPer-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?ZrLoggerOptional logger; silent by default.config.ts:41
userAgent?stringAppended to the built-in zrexpress-sdk/<version> node/<v> user agent.config.ts:43

Released under the MIT License. Not affiliated with ZR Express.