Options for runUdsSeq.

interface RunUdsSeqOptions {
    device?: string;
    onProgress?: (info: UdsSeqProgress) => void;
}

Properties

Properties

device?: string

Device name when the node is connected to more than one device. Same meaning as the device string argument.

onProgress?: (info: UdsSeqProgress) => void

Called when each enabled sequence item starts and when it finishes.

The callback is not awaited. Throw inside it, or return a rejected promise, and the sequence keeps running; the error is logged. Disabled items are skipped. pct is 0 when the first item starts and 100 when the last item finishes. If an item fails and stops the sequence, that item emits start only and the returned promise rejects.

Type declaration