Skip to main content

Class: Document

Represents a file either before or after processing.

Constructors

constructor

new Document(«destructured»): Document

Parameters

NameType
«destructured»Object
› attributes?TagAttributes
› modifiers?Object
› pathstring
› textstring | default

Returns

Document

Defined in

bluehawk/Document.ts:100

Properties

_sourceMapConsumer

Private Optional _sourceMapConsumer: SourceMapConsumer

Defined in

bluehawk/Document.ts:167


attributes

attributes: TagAttributes

Attributes that a tag can store information in for later processing by listeners.

These do not affect the identity of the document.

Defined in

bluehawk/Document.ts:70


id

Readonly id: string

The path and modifiers of the file form a way to identify this specific instance of a file.

A file at one path may result in multiple output files after processing (e.g. states).

Defined in

bluehawk/Document.ts:41


modifiers

Readonly modifiers: Object

Read-only attributes that contribute to the document's identity. Do not modify after the document's creation.

A file at one path may result in multiple output files after processing (e.g. states). Different instances of the same file can be distinguished with modifiers.

Index signature

▪ [key: string]: string

Defined in

bluehawk/Document.ts:62


path

path: string

The original path of the document.

Defined in

bluehawk/Document.ts:52


text

text: default

The source text as a conveniently editable magic string. See https://www.npmjs.com/package/magic-string for details.

Defined in

bluehawk/Document.ts:47

Accessors

basename

get basename(): string

Returns the name of the file with the file extension, if any.

Returns

string

Defined in

bluehawk/Document.ts:82


dirname

get dirname(): string

Returns the path of the directory containing this file based on the path.

Returns

string

Defined in

bluehawk/Document.ts:96


extension

get extension(): string

Returns the file extension, if any, including the dot.

Returns

string

Defined in

bluehawk/Document.ts:89


name

get name(): string

Returns the name of the file minus the file extension.

Returns

string

Defined in

bluehawk/Document.ts:75

Methods

getNewLocationFor

getNewLocationFor(oldLocation): Promise<undefined | { column: number ; line: number }>

Calculates the new position of the original line and column numbers.

Offset is ignored. This should only be done after all text transformations are finalized.

Parameters

NameType
oldLocationObject
oldLocation.columnnumber
oldLocation.linenumber

Returns

Promise<undefined | { column: number ; line: number }>

Defined in

bluehawk/Document.ts:136


pathWithInfix

pathWithInfix(infix): string

Parameters

NameType
infixstring

Returns

string

Defined in

bluehawk/Document.ts:126


makeId

makeId(newPath, modifiers?): string

Returns a uniform path + modifier combination to uniquely identify a file instance.

Parameters

NameType
newPathstring
modifiers?Object

Returns

string

Defined in

bluehawk/Document.ts:16