Skip to content

@terminaldz/zrexpress-sdk / nestjs / ZrExpressModuleOptions

Interface: ZrExpressModuleOptions ​

Defined in: nestjs/zrexpress.module.ts:21

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
apiKeystringX-Api-Key portal token. Required. Never logged or serialized.ZrExpressOptions.apiKeyconfig.ts:28
tenantIdstringX-Tenant GUID. Required (a handful of key/profile operations skip the header).ZrExpressOptions.tenantIdconfig.ts:30
baseUrl?stringAPI origin (default https://api.zrexpress.app).ZrExpressOptions.baseUrlconfig.ts:32
apiVersion?stringPath version segment (default '1' → /api/v1).ZrExpressOptions.apiVersionconfig.ts:34
timeoutMs?numberPer-attempt timeout (default 30_000 ms).ZrExpressOptions.timeoutMsconfig.ts:36
retry?ZrRetryOptions-ZrExpressOptions.retryconfig.ts:37
fetch?(input, init?) => Promise<Response>Injectable fetch (tests / custom dispatchers). Defaults to global fetch.ZrExpressOptions.fetchconfig.ts:39
logger?ZrLoggerOptional logger; silent by default.ZrExpressOptions.loggerconfig.ts:41
userAgent?stringAppended to the built-in zrexpress-sdk/<version> node/<v> user agent.ZrExpressOptions.userAgentconfig.ts:43
isGlobal?booleanRegister globally (default true); set false to scope the module.-nestjs/zrexpress.module.ts:23
webhook?objectWebhook signing secret (whsec_…) to enable ZrExpressWebhookGuard.-nestjs/zrexpress.module.ts:25
webhook.secret?string--nestjs/zrexpress.module.ts:25

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