@terminaldz/zrexpress-sdk / nestjs / ZrExpressModuleOptions
Interface: ZrExpressModuleOptions
Defined in: nestjs/zrexpress.module.ts:21
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
apiKey | string | X-Api-Key portal token. Required. Never logged or serialized. | ZrExpressOptions.apiKey | config.ts:28 |
tenantId | string | X-Tenant GUID. Required (a handful of key/profile operations skip the header). | ZrExpressOptions.tenantId | config.ts:30 |
baseUrl? | string | API origin (default https://api.zrexpress.app). | ZrExpressOptions.baseUrl | config.ts:32 |
apiVersion? | string | Path version segment (default '1' → /api/v1). | ZrExpressOptions.apiVersion | config.ts:34 |
timeoutMs? | number | Per-attempt timeout (default 30_000 ms). | ZrExpressOptions.timeoutMs | config.ts:36 |
retry? | ZrRetryOptions | - | ZrExpressOptions.retry | config.ts:37 |
fetch? | (input, init?) => Promise<Response> | Injectable fetch (tests / custom dispatchers). Defaults to global fetch. | ZrExpressOptions.fetch | config.ts:39 |
logger? | ZrLogger | Optional logger; silent by default. | ZrExpressOptions.logger | config.ts:41 |
userAgent? | string | Appended to the built-in zrexpress-sdk/<version> node/<v> user agent. | ZrExpressOptions.userAgent | config.ts:43 |
isGlobal? | boolean | Register globally (default true); set false to scope the module. | - | nestjs/zrexpress.module.ts:23 |
webhook? | object | Webhook signing secret (whsec_…) to enable ZrExpressWebhookGuard. | - | nestjs/zrexpress.module.ts:25 |
webhook.secret? | string | - | - | nestjs/zrexpress.module.ts:25 |