SerialDeframer
Defined in: src/transports/serialFraming.ts:29
Resync-tolerant de-framer for the MeshCore serial byte stream. Feed it raw bytes as they arrive; it returns zero or more complete companion-frame payloads, buffering any partial tail. Never throws on malformed input — it drops a byte and resyncs.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SerialDeframer(opts?): SerialDeframer;Defined in: src/transports/serialFraming.ts:33
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
opts? | { maxFrameBytes?: number; } |
opts.maxFrameBytes? | number |
Returns
Section titled “Returns”SerialDeframer
Methods
Section titled “Methods”push()
Section titled “push()”push(bytes): Uint8Array<ArrayBufferLike>[];Defined in: src/transports/serialFraming.ts:43
Append bytes and return every complete companion-frame payload now available.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
bytes | Uint8Array |
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>[]
reset()
Section titled “reset()”reset(): void;Defined in: src/transports/serialFraming.ts:38
Discard any buffered partial frame.
Returns
Section titled “Returns”void