Skip to main content
Version: v0.0.4

Interface: AstmFramePosition

Where in a framed byte stream a warning or error originated. Both members are positional; neither is a value.

Example

import type { AstmFramePosition } from "@cosyte/astm";
const at: AstmFramePosition = { frameNumber: 2, byteOffset: 251 };

Properties

byteOffset

readonly byteOffset: number

Byte offset of the STX that opened the frame, within the decoded stream.


frameNumber?

readonly optional frameNumber?: number

The frame's sequence number (07) when it could be read, or undefined when the frame was so truncated the number was not present.