Interface: NumericDurationSchema¶
core.NumericDurationSchema
A schema representing a return value or object property that is provided as a number, which Coda should interpret as a duration. The given number should be an amount of days (fractions allowed).
Hierarchy¶
BaseNumberSchema<Duration>
↳ NumericDurationSchema
Properties¶
codaType¶
• codaType: Duration
Instructs Coda to render this value as a duration.
Overrides¶
BaseNumberSchema.codaType
Defined in¶
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¶
maxUnit¶
• Optional maxUnit: DurationUnit
The unit to use for rounding the duration when rendering. For example, if using DurationUnit.Days,
and a value of 273600 is provided (3 days 4 hours) is provided, it will be rendered as "3 days".
Defined in¶
precision¶
• Optional precision: number
A refinement of maxUnit to use for rounding the duration when rendering.
Currently only 1 is supported, which is the same as omitting a value.
Defined in¶
type¶
• type: Number
Identifies this schema as relating to a number value.
Inherited from¶
BaseNumberSchema.type