Formats

variables[].format defines how a Variable's value should be displayed. The API applies the format and returns the result in valueFormatted. Formatting is most commonly used for Number, Percent, and Date Variables.

{
  "format": "0[.]0",
  "value": 1.23,
  "valueFormatted": "1.2"
}

See Variables: Format for the broader Variables context.

Numbers

Number format strings follow Numeral.js.

Common format strings

Custom formats

Taffrail adds a n/d token that converts a fraction to its Unicode equivalent — for example, 1/2 becomes ½.

n/d composes with Numeral format strings. The portion before n/d is the Numeral format applied to the integer part:

• 0.0n/d formats 1.5 as 1½.
• 0[.]00n/d formats 1.2345 as 1.23 (the value rounds before the fraction substitution kicks in).

🚧

Plain numbers only

n/d does not combine with abbreviation, ordinal, percent, or currency tokens.

Dates

Date format strings follow date-fns format.

Common date formats