Skip to main content
Version: v0.0.3

Interface: MllpWarning

A frozen warning object emitted when the decoder tolerates a framing deviation.

connectionId is undefined when emitted by a standalone FrameReader. Connection enriches it to the real UUIDv4 before forwarding upstream.

Example

const reader = new FrameReader({
onFrame: (p) => process(p),
onWarning: (w: MllpWarning) => logger.warn(w),
allowFsOnly: true,
});

Properties

byteOffset

readonly byteOffset: number

Absolute stream byte offset where the anomaly was detected.


code

readonly code: WarningCode


connectionId

readonly connectionId: string | undefined

Connection identifier. undefined at the framing layer; enriched by Connection before emitting upstream.


message

readonly message: string

Stable human-readable description. Never contains payload bytes or secrets.


timestamp

readonly timestamp: Date

Wall-clock time at point of emission.