SigningOptions
Defined in: packages/api-client/src/core/interceptors/signingInterceptor.ts:37
Properties
Section titled “Properties”debug?
Section titled “debug?”
optionaldebug?:boolean
Defined in: packages/api-client/src/core/interceptors/signingInterceptor.ts:55
When true, throw a clear error if the secret is missing on a
whitelisted request. When false (default) silently skip signing —
the BE will reject the request and the user will see the standard
error path.
getSecret
Section titled “getSecret”getSecret: () =>
string|undefined
Defined in: packages/api-client/src/core/interceptors/signingInterceptor.ts:43
Function returning the HMAC secret. Called per-request so callers can
lazily resolve the env value (and we surface undefined cleanly when
the secret is missing).
Returns
Section titled “Returns”string | undefined
logger?
Section titled “logger?”
optionallogger?:Logger
Defined in: packages/api-client/src/core/interceptors/signingInterceptor.ts:61
Logger used to surface non-throwing diagnostics. Defaults to no-op so the SDK never writes to a platform-specific console unless the consumer opts in.
whitelist?
Section titled “whitelist?”
optionalwhitelist?: readonlyobject[]
Defined in: packages/api-client/src/core/interceptors/signingInterceptor.ts:48
Optional override of the whitelist (mainly for tests). Defaults to
SIGNING_WHITELIST.