njs-modbus 3.2.0 → 3.3.0

package/dist/index.d.ts

@@ -12,7 +12,7 @@ interface ApplicationDataUnit {
     data: Buffer;
 }
 interface ServerId {
-    /** Server ID; may be 1 byte (number) or multi-byte (number[]) per device spec. */
+    /** Server ID as a byte array (e.g. single-byte IDs use `[id]`). */
     serverId?: number[];
     runIndicatorStatus?: boolean;
     additionalData?: number[];
@@ -52,6 +52,8 @@ interface CustomFunctionCode {
      * @param start — Byte offset in `buffer` where the current candidate frame begins
      *   (the unit ID byte). Read the function code at `buffer[start + 1]` and derive
      *   the total frame length from the trailing bytes.
+     * @param end — Byte offset one past the last valid byte. Bounds checks must use
+     *   `end - start` as available bytes, NOT `buffer.length` (pool capacity).
      * @returns Total frame length (>= 4, <= 256), or `null` if more bytes are needed.
      */
     predictRequestLength: (buffer: Buffer, start: number, end: number) => number | null;
@@ -670,7 +672,7 @@ declare class ModbusMaster<T extends ModbusMasterOptions = ModbusMasterOptions>
     sendCustomFC(unit: 0, fc: number, data: Buffer | number[], timeout?: number): Promise<void>;
     sendCustomFC(unit: number, fc: number, data: Buffer | number[], timeout?: number): Promise<Buffer>;
     /**
-     * Open the underlying physical layer and begin accepting connections.
+     * Open the underlying physical layer and establish a connection.
      *
      * A `ModbusMaster` instance can only be opened once. Once {@link close}
      * is called — explicitly or because the physical layer disconnected —
@@ -715,15 +717,19 @@ interface ModbusSlaveModel {
      * Otherwise keep the default read and write behavior.
      */
     interceptor?: MaybeAsyncFunction<(fc: number, data: Buffer) => Buffer | undefined>;
-    readDiscreteInputs?: MaybeAsyncFunction<(address: number, length: number) => boolean[]>;
-    readCoils?: MaybeAsyncFunction<(address: number, length: number) => boolean[]>;
+    /** Return `Uint8Array` to avoid the `Array.from` allocation overhead. */
+    readDiscreteInputs?: MaybeAsyncFunction<(address: number, length: number) => boolean[] | Uint8Array>;
+    /** Return `Uint8Array` to avoid the `Array.from` allocation overhead. */
+    readCoils?: MaybeAsyncFunction<(address: number, length: number) => boolean[] | Uint8Array>;
     writeSingleCoil?: MaybeAsyncFunction<(address: number, value: boolean) => void>;
     /**
      * If omitted, defaults to loop and call `writeSingleCoil`.
      */
     writeMultipleCoils?: MaybeAsyncFunction<(address: number, value: boolean[]) => void>;
-    readInputRegisters?: MaybeAsyncFunction<(address: number, length: number) => number[]>;
-    readHoldingRegisters?: MaybeAsyncFunction<(address: number, length: number) => number[]>;
+    /** Return `Uint16Array` to avoid the `Array.from` allocation overhead. */
+    readInputRegisters?: MaybeAsyncFunction<(address: number, length: number) => number[] | Uint16Array>;
+    /** Return `Uint16Array` to avoid the `Array.from` allocation overhead. */
+    readHoldingRegisters?: MaybeAsyncFunction<(address: number, length: number) => number[] | Uint16Array>;
     writeSingleRegister?: MaybeAsyncFunction<(address: number, value: number) => void>;
     /**
      * If omitted, defaults to loop and call `writeSingleRegister`.