Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/tools / / ResultReadRange

Interface: ResultReadRange

Defined in: packages/tools/src/result/reader.ts:32

Range selector for ResultReader.read. A line range (startLine/endLine, 1-based inclusive) takes precedence over a byte range (offset/length) when both are supplied. maxBytes caps the returned slice regardless of mode.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
endLine?readonlynumberLast line to return, 1-based inclusive (line mode).packages/tools/src/result/reader.ts:40
length?readonlynumberByte length to return (byte mode). Default: to end (subject to maxBytes).packages/tools/src/result/reader.ts:36
maxBytes?readonlynumberHard cap on returned bytes.packages/tools/src/result/reader.ts:42
offset?readonlynumberByte offset into the artifact (byte mode). Default 0.packages/tools/src/result/reader.ts:34
startLine?readonlynumberFirst line to return, 1-based inclusive (line mode).packages/tools/src/result/reader.ts:38