Class ParseResult

constructor

• new ParseResult(entries: Entry[]): ParseResult

  Creates a new ParseResult instance.

  Parameters

  • entries: Entry[]

    Array of parsed Entry objects

  Returns ParseResult

entries

balance

• get balance(): Entry[]

  Gets all balance entries from the parsed entries.

  Returns Entry[]

  Array of entries that are balance directives

blankline

• get blankline(): Entry[]

  Gets all blankline entries from the parsed entries.

  Returns Entry[]

  Array of entries that are blank lines

close

• get close(): Entry[]

  Gets all close entries from the parsed entries.

  Returns Entry[]

  Array of entries that are close directives

comment

• get comment(): Entry[]

  Gets all comment entries from the parsed entries.

  Returns Entry[]

  Array of entries that are comments

commodity

• get commodity(): Entry[]

  Gets all commodity entries from the parsed entries.

  Returns Entry[]

  Array of entries that are commodity directives

custom

• get custom(): Entry[]

  Gets all custom entries from the parsed entries.

  Returns Entry[]

  Array of entries that are custom directives

document

• get document(): Entry[]

  Gets all document entries from the parsed entries.

  Returns Entry[]

  Array of entries that are document directives

event

• get event(): Entry[]

  Gets all event entries from the parsed entries.

  Returns Entry[]

  Array of entries that are event directives

include

• get include(): Entry[]

  Gets all include entries from the parsed entries.

  Returns Entry[]

  Array of entries that are include directives

note

• get note(): Entry[]

  Gets all note entries from the parsed entries.

  Returns Entry[]

  Array of entries that are note directives

open

• get open(): Entry[]

  Gets all open entries from the parsed entries.

  Returns Entry[]

  Array of entries that are open directives

option

• get option(): Entry[]

  Gets all option entries from the parsed entries.

  Returns Entry[]

  Array of entries that are option directives

pad

• get pad(): Entry[]

  Gets all pad entries from the parsed entries.

  Returns Entry[]

  Array of entries that are pad directives

plugin

• get plugin(): Entry[]

  Gets all plugin entries from the parsed entries.

  Returns Entry[]

  Array of entries that are plugin directives

poptag

• get poptag(): Entry[]

  Gets all poptag entries from the parsed entries.

  Returns Entry[]

  Array of entries that are poptag directives

price

• get price(): Entry[]

  Gets all price entries from the parsed entries.

  Returns Entry[]

  Array of entries that are price directives

pushtag

• get pushtag(): Entry[]

  Gets all pushtag entries from the parsed entries.

  Returns Entry[]

  Array of entries that are pushtag directives

query

• get query(): Entry[]

  Gets all query entries from the parsed entries.

  Returns Entry[]

  Array of entries that are query directives

transactions

• get transactions(): Entry[]

  Gets all transaction entries from the parsed entries.

  Returns Entry[]

  Array of entries that are transactions

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 entries to a formatted string with aligned columns. Uses each entry'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 entries to their string representation. Each entry 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 entry by mapping it to the appropriate Entry class based on its type.

  Parameters

  • obj: ParseResultObj

    Plain object representation of a ParseResult

  Returns ParseResult

  A new ParseResult instance with deserialized entries

  Throws

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

  Remarks

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