Skip to content

Interface: CurrencySchema

core.CurrencySchema

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

Hierarchy

CurrencySchema

Properties

codaType

codaType: Currency

Instructs Coda to render this value as a currency amount.

Overrides

BaseNumberSchema.codaType

Defined in

schema.ts:374


currencyCode

Optional currencyCode: string

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

Defined in

schema.ts:381


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

Defined in

schema.ts:215


format

Optional format: CurrencyFormat

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

Defined in

schema.ts:383


precision

Optional precision: number

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

Defined in

schema.ts:376


type

type: Number

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type

Defined in

schema.ts:250