Interface: CurrencySchema¶

A schema representing a return value or object property that is an amount of currency.

Extends¶

BaseNumberSchema<Currency>

Properties¶

codaType¶

codaType: Currency

Instructs Superhuman Docs to render this value as a currency amount.

Overrides¶

BaseNumberSchema.codaType

currencyCode?¶

optional currencyCode: string

A three-letter ISO 4217 currency code, e.g. USD or EUR. If the currency code is not supported by Superhuman Docs, the value will be rendered using USD.

description?¶

optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

Inherited from¶

BaseNumberSchema.description

format?¶

optional format: CurrencyFormat

A render format for further refining how the value is rendered.

precision?¶

optional precision: number

The decimal precision. The value is rounded to this precision when rendered.

type¶

type: Number

Identifies this schema as relating to a number value.

Inherited from¶

BaseNumberSchema.type