beancount
    Preparing search index...

    Class Option

    Represents an Option entry that sets a Beancount configuration option. Option directives configure various aspects of Beancount's behavior.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    comment? internalMetadata name type value

    Methods

    parseJSONData toFormattedString toString fromGenericParseResult fromJSON fromJSONData fromString

    Constructors

    Properties

    comment?: string

    Optional comment text associated with this entry

    internalMetadata: Record<string, unknown> = {}

    Internal metadata key-value pairs associated with this entry. These can be anything, are not used in the output, and are meant to be used to allow your pipeline to keep track of an internal property

    name: string

    The option name

    type: "option" = ...

    The type of this entry (e.g., 'open', 'close', 'transaction', 'comment', 'blankline')

    value: Value

    The option value

    Methods

    • Transforms JSON data before creating an Entry instance. Default implementation returns the input unchanged. Subclasses can override this to handle custom deserialization logic (e.g., converting nested objects, handling dates, etc.).

      Parameters

      • json: Record<string, unknown>

        The JSON data to transform

      Returns Record<string, unknown>

      The transformed data ready for the constructor

    • Converts this entry to a formatted string with aligned columns. Default implementation delegates to toString(). Subclasses can override for custom formatting.

      Parameters

      • _formatOptions: FormatOptions = defaultFormatOptions

        Formatting options (unused in base implementation)

      Returns string

      The formatted string representation of this entry

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

      Type Parameters

      Parameters

      • this: new (obj: any) => T
      • jsonString: string

        JSON data representing an entry

      Returns T

      A new instance of the Entry subclass

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

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

      Type Parameters

      Parameters

      • this: new (obj: any) => T
      • jsonData: Record<string, unknown>

        object representing an entry

      Returns T

      A new instance of the Entry subclass

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

    • Creates an Entry instance from a Beancount string. Parses the input string and constructs the appropriate Entry subclass.

      Type Parameters

      Parameters

      • this: EntryConstructor<T>
      • input: string

        A single Beancount entry as a string

      Returns T

      A new instance of the Entry subclass

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods