Interface: NumericSchema¶

A schema representing a return value or object property that is a numeric value, i.e. a raw number with an optional decimal precision.

Extends¶

optional codaType: Percent

If specified, instructs Superhuman Docs to render this value as a percentage.

BaseNumberSchema.codaType

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.

BaseNumberSchema.description

optional precision: number

The decimal precision. The number will be rounded to this precision when rendered.

type: Number

Identifies this schema as relating to a number value.

BaseNumberSchema.type

optional useThousandsSeparator: boolean

If specified, will render thousands separators for large numbers, e.g. 1,234,567.89.