Class ParseResult

constructor

• new ParseResult(nodes: Node[]): ParseResult

  Creates a new ParseResult instance.

  Parameters

  • nodes: Node[]

    Array of parsed nodes

  Returns ParseResult

nodes

accounts

• get accounts(): Set<string>

  Gets all unique account names used across all directives. Extracts accounts from transactions (via postings), open, close, balance, pad, note, and document nodes.

  Returns Set<string>

  Set of unique account names

balance

• get balance(): Balance[]

  Gets all balance nodes from the parsed nodes.

  Returns Balance[]

  Array of nodes that correspond to balance directives

blankline

• get blankline(): Blankline[]

  Gets all blankline nodes from the parsed nodes.

  Returns Blankline[]

  Array of nodes that correspond to a blank line

close

• get close(): Close[]

  Gets all close nodes from the parsed nodes.

  Returns Close[]

  Array of nodes that correspond to close directives

comment

• get comment(): Comment[]

  Gets all comment nodes from the parsed nodes.

  Returns Comment[]

  Array of nodes that correspond to a comments

commodity

• get commodity(): Commodity[]

  Gets all commodity nodes from the parsed nodes.

  Returns Commodity[]

  Array of nodes that correspond to commodity directives

custom

• get custom(): Custom[]

  Gets all custom nodes from the parsed nodes.

  Returns Custom[]

  Array of nodes that correspond to custom directives

document

• get document(): Document[]

  Gets all document nodes from the parsed nodes.

  Returns Document[]

  Array of nodes that correspond to document directives

event

• get event(): Event[]

  Gets all event nodes from the parsed nodes.

  Returns Event[]

  Array of nodes that correspond to event directives

include

• get include(): Include[]

  Gets all include nodes from the parsed nodes.

  Returns Include[]

  Array of nodes that correspond to include directives

note

• get note(): Note[]

  Gets all note nodes from the parsed nodes.

  Returns Note[]

  Array of nodes that correspond to note directives

open

• get open(): Open[]

  Gets all open nodes from the parsed nodes.

  Returns Open[]

  Array of nodes that correspond to open directives

option

• get option(): Option[]

  Gets all option nodes from the parsed nodes.

  Returns Option[]

  Array of nodes that correspond to option directives

pad

• get pad(): Pad[]

  Gets all pad nodes from the parsed nodes.

  Returns Pad[]

  Array of nodes that correspond to pad directives

plugin

• get plugin(): Plugin[]

  Gets all plugin nodes from the parsed nodes.

  Returns Plugin[]

  Array of nodes that correspond to plugin directives

poptag

• get poptag(): Poptag[]

  Gets all poptag nodes from the parsed nodes.

  Returns Poptag[]

  Array of nodes that correspond to poptag directives

price

• get price(): Price[]

  Gets all price nodes from the parsed nodes.

  Returns Price[]

  Array of nodes that correspond to price directives

pushtag

• get pushtag(): Pushtag[]

  Gets all pushtag nodes from the parsed nodes.

  Returns Pushtag[]

  Array of nodes that correspond to pushtag directives

query

• get query(): Query[]

  Gets all query nodes from the parsed nodes.

  Returns Query[]

  Array of nodes that correspond to query directives

transactions

• get transactions(): Transaction[]

  Gets all transaction nodes from the parsed nodes.

  Returns Transaction[]

  Array of nodes that correspond to transaction directives

accountsActiveAt

• accountsActiveAt(date: PlainDate): Set<string>

  Gets all accounts that are active (open and not yet closed) at a given date. An account is considered active if:

  • It has an open directive with date <= the given date
  • It either has no close directive, or the close directive date > the given date

  Parameters

  • date: PlainDate

    The date to check account status for

  Returns Set<string>

  Set of account names that are active on the given date

calculateCurrencyColumn

• calculateCurrencyColumn(options?: CalculateCurrencyColumnOptions): number

  Calculates the optimal currency column position for formatting.

  The currency column is determined by analyzing all postings across transactions and finding the maximum widths needed for account names and amounts.

  Formula: currencyColumn = maxLeftPartLength + maxAmountLength + minPadding + 6

  Where:

  • maxLeftPartLength = max((flag.length + 1 if flag) + account.length)
  • maxAmountLength = max(amount.length) for all postings with amounts
  • minPadding = desired minimum spaces between account and amount (default: 2)
  • 6 = fixed overhead (2 for indent + 2 for spacing + 2 for buffer)

  Parameters

  • options: CalculateCurrencyColumnOptions = {}

    Optional configuration for the calculation

  Returns number

  The calculated currency column position (1-indexed)

  Example

  const parseResult = parse(beancountString)
  const currencyColumn = parseResult.calculateCurrencyColumn()
  const formatted = parseResult.toFormattedString({ currencyColumn })
  Copy

toFormattedString

• toFormattedString(formatOptions?: FormatOptions): string

  Converts all nodes to a formatted string with aligned columns. Uses each node's toFormattedString() method for consistent formatting.

  Parameters

  • formatOptions: FormatOptions = defaultFormatOptions

    Formatting options

  Returns string

  The formatted Beancount file content as a string

toString

• toString(): string

  Converts all nodes to their string representation. Each node is converted using its toString() method and joined with newlines.

  Returns string

  The complete Beancount file content as a string

StaticfromJSON

• fromJSON(jsonString: string): ParseResult

  Creates an ParseResult instance from JSON data. Calls fromJSONData to allow subclasses to transform the data before construction.

  Parameters

  • jsonString: string

    JSON data representing an ParseResult

  Returns ParseResult

  A new instance of ParseResult loaded with the data in the JSON

  Remarks

  Warning: No validation is performed on the JSON input. We assume the JSON is valid and well-formed.

StaticfromJSONData

• fromJSONData(obj: ParseResultObj): ParseResult

  Creates a ParseResult instance from a plain JavaScript object. Deserializes each node by mapping it to the appropriate Node class based on its type.

  Parameters

  • obj: ParseResultObj

    Plain object representation of a ParseResult

  Returns ParseResult

  A new ParseResult instance with deserialized nodes

  Throws

  If an node has an unknown type with no corresponding node class

  Remarks

  Warning: No validation is performed on the input object. We assume the object is valid and well-formed.