Class FlatBufferParser

Stateless decoder for FlatBuffer Scan payloads received over NATS.

Index

Constructors

Methods

Constructors

constructor

new FlatBufferParser(): FlatBufferParser
Returns FlatBufferParser

Methods

parse

parse(buffer: ArrayBuffer | Uint8Array<ArrayBufferLike>): ScanData | null
Decodes a FlatBuffer Scan payload.

The input may be a view onto part of a larger buffer, as NATS WebSocket payloads are; it is decoded in place, without copying the payload. The values are copied out in one block (see copyValues) instead of through the generated Float64Array view, which fails on payloads that are not 8-byte aligned.

The payload is not verified against the schema. Errors are logged to the console.
Parameters
- buffer: ArrayBuffer | Uint8Array<ArrayBufferLike>
  Message payload bytes.
Returns ScanData | null
The decoded scan, or null if it has no values or decoding throws.
Example
```
const parser = new FlatBufferParser();
const scan = parser.parse(msg.data);
if (scan) console.log(scan.values.length, scan.firstSampleUnixNs);
```
- Defined in flatbuffer-parser.ts:104