Heatzy API for Node.js - v13.0.0
    Preparing search index...

    Interface HeatzyAPIAdapter

    The API surface facades depend on — a structural slice of HeatzyAPI that keeps the facade layer decoupled from the client's lifecycle machinery (and trivially mockable in tests).

    interface HeatzyAPIAdapter {
        fetch: () => Promise<readonly DeviceBinding[]>;
        getValues: (__namedParameters: { id: string }) => Promise<Attributes>;
        locale: string | undefined;
        notifySync: SyncCallback;
        timezone: string | undefined;
        updateValues: (
            __namedParameters: { id: string; postData: DevicePostDataAny },
        ) => Promise<void>;
    }

    Implemented by

    Index
    fetch getValues locale notifySync timezone updateValues
    fetch: () => Promise<readonly DeviceBinding[]>

    Fetch all bindings and sync the device registry.

    getValues: (__namedParameters: { id: string }) => Promise<Attributes>

    Read the live attribute payload of a single device.

    locale: string | undefined

    BCP-47 locale tag the instance was configured with (HeatzyAPIConfig.locale), or undefined when unset. Facades use it to render derogationEndString labels without a mutable global locale.

    notifySync: SyncCallback

    Notify any registered events.onSyncComplete observer that a sync just landed. Routed through the lifecycle emitter so a misbehaving observer cannot break the caller.

    timezone: string | undefined

    IANA timezone identifier the instance was configured with (HeatzyAPIConfig.timezone), or undefined when unset. Facades use it to anchor derogation end dates to the account timezone instead of the host runtime timezone.

    updateValues: (
        __namedParameters: { id: string; postData: DevicePostDataAny },
    ) => Promise<void>

    Send a control payload to a single device.

    Settings
    Member Visibility

    On This Page
    Properties