Interface: CurrencySchema¶
Defined in: schema.ts:436
A schema representing a return value or object property that is an amount of currency.
Extends¶
BaseNumberSchema<Currency>
Properties¶
codaType¶
codaType:
Currency
Defined in: schema.ts:438
Instructs Coda to render this value as a currency amount.
Overrides¶
BaseNumberSchema.codaType
currencyCode?¶
optionalcurrencyCode:string
Defined in: schema.ts:445
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.
description?¶
optionaldescription:string
Defined in: schema.ts:285
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?¶
optionalformat:CurrencyFormat
Defined in: schema.ts:447
A render format for further refining how the value is rendered.
precision?¶
optionalprecision:number
Defined in: schema.ts:440
The decimal precision. The value is rounded to this precision when rendered.
type¶
type:
Number
Defined in: schema.ts:314
Identifies this schema as relating to a number value.
Inherited from¶
BaseNumberSchema.type