Class: Document
Represents a file either before or after processing.
Constructors
constructor
• new Document(«destructured»): Document
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› attributes? | TagAttributes |
› modifiers? | Object |
› path | string |
› text | string | default |
Returns
Defined in
Properties
_sourceMapConsumer
• Private Optional _sourceMapConsumer: SourceMapConsumer
Defined in
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
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
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
path
• path: string
The original path of the document.
Defined in
text
• text: default
The source text as a conveniently editable magic string. See https://www.npmjs.com/package/magic-string for details.
Defined in
Accessors
basename
• get basename(): string
Returns the name of the file with the file extension, if any.
Returns
string
Defined in
dirname
• get dirname(): string
Returns the path of the directory containing this file based on the path.
Returns
string
Defined in
extension
• get extension(): string
Returns the file extension, if any, including the dot.
Returns
string
Defined in
name
• get name(): string
Returns the name of the file minus the file extension.
Returns
string
Defined in
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
| Name | Type |
|---|---|
oldLocation | Object |
oldLocation.column | number |
oldLocation.line | number |
Returns
Promise<undefined | { column: number ; line: number }>
Defined in
pathWithInfix
▸ pathWithInfix(infix): string
Parameters
| Name | Type |
|---|---|
infix | string |
Returns
string
Defined in
makeId
▸ makeId(newPath, modifiers?): string
Returns a uniform path + modifier combination to uniquely identify a file instance.
Parameters
| Name | Type |
|---|---|
newPath | string |
modifiers? | Object |
Returns
string