Class Document

constructor

• new Document(sourceText: string, options?: DocumentOptions): Document

  Parameters

  • sourceText: string
  • options: DocumentOptions = {}

  Returns Document

Readonlybody

Readonlysource

delete

• delete(path: string | PathSegment[]): boolean

  Remove an attribute or block at path. Returns true when something was removed, false when the path did not resolve.

  Parameters

  • path: string | PathSegment[]

  Returns boolean

get

• get(path: string | PathSegment[]): Node | undefined

  Resolve a path to its CST node. Returns undefined if the path does not exist. For duplicate-block groups with no numeric index given, returns the first matching block (matching HCL.parse's grouping semantics when accessing by key).

  Parameters

  • path: string | PathSegment[]

  Returns Node | undefined

set

• set(path: string | PathSegment[], value: Value): void

  Replace the value of an existing attribute, or insert a new attribute at the end of the enclosing body. The attribute's surrounding trivia (leading comments, same-line trailing comments) is preserved on replacement.

  Parameters

  • path: string | PathSegment[]
  • value: Value

  Returns void

toString

• toString(): string

  Re-emit the current CST. For an unedited Document, this is byte-identical to the original source by construction.

  Returns string

toValue

• toValue(): Value

  Convert the CST to the same Value shape that HCL.parse returns.

  Returns Value