Skip to content

Interface: DurationSchema

A schema representing a return value or object property that represents a duration. The value should be provided as a string like "3 days" or "40 minutes 30 seconds".

Extends

Properties

codaType?

optional codaType: Duration

An optional type hint instructing Superhuman Docs about how to interpret or render this value.

Inherited from

BaseStringSchema.codaType

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

BaseStringSchema.description

maxUnit?

optional maxUnit: DurationUnit

The unit to use for rounding the duration when rendering. For example, if using DurationUnit.Days, and a value of "3 days 4 hours" is provided, it will be rendered as "3 days".

precision?

optional precision: number

A refinement of DurationSchema.maxUnit to use for rounding the duration when rendering. Currently only 1 is supported, which is the same as omitting a value.

type

type: String

Identifies this schema as a string.

Inherited from

BaseStringSchema.type