Logo Xantham

SourceFileRecord Module

Byte offsets into the `SourceFile` node's extended-data record. Unlike everything else here, this layout is not in `ast.json`. The record is written by a hand-written Go function and read by hand-written TypeScript, so the only statement of its shape is the format documentation in `encoder.go`, which the generator parses. Every field is a `uint32`; `Ast` in `Library.fs` is what gives them meaning.

Functions and values

Function or value Description

SourceFileRecord.Absent

Full Usage: SourceFileRecord.Absent

Returns: uint32

The value a structured-data offset or string index carries when the field is absent.

Returns: uint32

SourceFileRecord.AmbientModuleNames

Full Usage: SourceFileRecord.AmbientModuleNames

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `ambientModuleNames` string array.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.CanonicalSourceFileName

Full Usage: SourceFileRecord.CanonicalSourceFileName

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `canonicalSourceFileName`, or noStructuredData.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.ContentMapper

Full Usage: SourceFileRecord.ContentMapper

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `contentMapper`, or noStructuredData.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.DiagnosticDirectives

Full Usage: SourceFileRecord.DiagnosticDirectives

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `diagnosticDirectives` in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.ExternalModuleIndicator

Full Usage: SourceFileRecord.ExternalModuleIndicator

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Node index of `externalModuleIndicator` (0 = nil).

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.FileName

Full Usage: SourceFileRecord.FileName

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `fileName` in the string offsets section.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.Imports

Full Usage: SourceFileRecord.Imports

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `imports` node index array in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.LanguageVariant

Full Usage: SourceFileRecord.LanguageVariant

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Value of `languageVariant`.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.LibReferenceDirectives

Full Usage: SourceFileRecord.LibReferenceDirectives

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `libReferenceDirectives` in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.ModuleAugmentations

Full Usage: SourceFileRecord.ModuleAugmentations

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `moduleAugmentations` node index array.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.OriginalText

Full Usage: SourceFileRecord.OriginalText

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `originalText` in the string offsets section.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.Path

Full Usage: SourceFileRecord.Path

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `path` in the string offsets section.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.ReferencedFiles

Full Usage: SourceFileRecord.ReferencedFiles

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `referencedFiles` in structured data section.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.ScriptKind

Full Usage: SourceFileRecord.ScriptKind

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Value of `scriptKind`.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.Size

Full Usage: SourceFileRecord.Size

Returns: int

The record's total size in bytes.

Returns: int

SourceFileRecord.SpanMap

Full Usage: SourceFileRecord.SpanMap

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `spanMap` in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.SupplementalSourceFileNames

Full Usage: SourceFileRecord.SupplementalSourceFileNames

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `supplementalSourceFileNames` in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.Text

Full Usage: SourceFileRecord.Text

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `text` in the string offsets section.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.TypeReferenceDirectives

Full Usage: SourceFileRecord.TypeReferenceDirectives

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Byte offset of `typeReferenceDirectives` in structured data.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

SourceFileRecord.VirtualFileName

Full Usage: SourceFileRecord.VirtualFileName

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Index of `virtualFileName`, or noStructuredData.

Returns: int<MeasureProduct<byteOffset, MeasureOne>>

Type something to start searching.