Interface IntervalConfiguration<T>

Represents the configuration for an interval-based operation on a device.

interface IntervalConfiguration<T> {
    disableAutoStart?: boolean;
    functionName: keyof T & string;
    intervalSeconds?: number;
    settingName?: T extends Device
        ? string
        : undefined;
}

Type Parameters

Properties

disableAutoStart? functionName intervalSeconds? settingName?

Properties

OptionaldisableAutoStart

disableAutoStart?: boolean

An optional flag to disable the automatic start of the interval.

functionName

functionName: keyof T & string

The name of the function to be executed on the device, must be defined by the device instance.

OptionalintervalSeconds

intervalSeconds?: number

An optional interval time in seconds for configuring delay between executions of T.functionName(). This takes precedence

OptionalsettingName

settingName?: T extends Device
    ? string
    : undefined

An optional setting name associated with the interval operation. If specified and contains a valid number value, this is used as the delay between intervals. This takes precedence over IntervalConfiguration.intervalSeconds.

Settings

Member Visibility

On This Page

Properties