Optional ReadonlyabortOptional shutdown signal applied to every outgoing request.
When the signal fires, all in-flight HTTP requests abort with a
DOMException of name AbortError. Subsequent calls from the same
client instance will also abort immediately. Use this to tie the
SDK lifetime to a host process lifetime — e.g. pass the Homey
app's shutdown signal so outstanding requests don't dangle across
a reload.
Optional ReadonlyeventsStructured-events callbacks invoked around SDK lifecycle moments. Useful to plug the SDK into a host observability stack (pino / winston / OpenTelemetry / custom metrics).
Optional ReadonlylocaleBCP-47 locale tag used by facades to render derogation end labels
(derogationEndString). Defaults to the runtime locale.
Optional ReadonlyloggerCustom logger. Defaults to console.
Optional ReadonlypasswordOptional ReadonlysettingExternal setting manager for persisting credentials and session data.
Optional ReadonlyshouldRestore the persisted session in the background instead of awaiting
it inside create(). Session probing and full logins can take tens
of seconds on slow networks, which blows a host app's init budget
(e.g. Homey's 30 s ready timeout). The lifecycle contract is
unchanged — auto-sync arming, onAuthenticationLost, login
backoff — it just runs off the critical path; isAuthenticated()
may report false until the background restore lands.
Optional ReadonlysyncAuto-sync timer in minutes. false disables the timer entirely.
Omit to use the subclass default.
Optional ReadonlytimezoneIANA timezone identifier anchoring derogation end dates. Defaults to the runtime system timezone.
Optional ReadonlytransportHTTP transport: pre-built HttpClient or build options.
Optional Readonlyusername
Configuration accepted by HeatzyAPI.create: the core's session surface (
SessionAPIConfig—logger,settingManager, and the members re-declared below to carry this dialect's own guidance) plus the Gizwits dialect's own. Every property — including the inherited LoginCredentials pair — may be absent or explicitlyundefined, interchangeably: the runtime applies the same default either way (credentials can also arrive later viaauthenticateor the SettingManager).