Beancount.Directives.Option (beancount_ex v0.6.0)

Copy Markdown View Source

The option directive sets file-wide Beancount configuration.

See Options.

Beancount syntax

option "title" "My Ledger"
option "operating_currency" "USD"
option "infer_tolerance_from_cost" TRUE

General form: option "Name" Value

This directive has no date.

Elixir struct

%Beancount.Directives.Option{
  name: "operating_currency",
  value: "USD"
}

%Beancount.Directives.Option{
  name: "infer_tolerance_from_cost",
  value: true
}

Or use Beancount.option/2:

Beancount.option("operating_currency", "USD")
Beancount.option("infer_tolerance_from_cost", true)

Fields

  • name - option key string. Common values: "title", "operating_currency", "inferred_tolerance_default", "inferred_tolerance_multiplier", "infer_tolerance_from_cost", "tolerance_multiplier".
  • value - option value: binary, boolean (true/false rendered as TRUE/FALSE), Decimal, Date, or atom.

Summary

Types

t()

@type t() :: %Beancount.Directives.Option{name: String.t(), value: term()}