Interface Framing

One of the two byte-stuffing framings this module offers.

interface Framing {
    decode(frame: Uint8Array): Buffer;
    encode(payload: Uint8Array): Buffer;
    maxEncodedLen(payloadLen: number): number;
}

Index

Methods

decode encode maxEncodedLen

Methods

decode

decode(frame: Uint8Array): Buffer
Reads the payload back out of a complete frame.
Parameters
- frame: Uint8Array
  The frame as it arrived.
Returns Buffer
The payload.

Throws
If the frame is corrupt.
- Defined in serial/dist/index.d.ts:31

encode

encode(payload: Uint8Array): Buffer
Frames a payload for the wire.
Parameters
- payload: Uint8Array
  The bytes to send.
Returns Buffer
The frame, delimiter included.
- Defined in serial/dist/index.d.ts:23

maxEncodedLen

maxEncodedLen(payloadLen: number): number
Returns the largest frame a payload of this length can produce.
Parameters
- payloadLen: number
  The payload length in bytes.
Returns number
The worst-case frame length.
- Defined in serial/dist/index.d.ts:38