Interface: StringDateTimeSchema

Defined in: schema.ts:687

A schema representing a return value or object property that is provided as a string, which Superhuman Docs should interpret as a datetime. Superhuman Docs is able to flexibly a parse number of formal and informal string representations of dates. For maximum accuracy, consider using an ISO 8601 datetime string (e.g. 2021-11-03T19:43:58): https://en.wikipedia.org/wiki/ISO_8601.

Extends

• BaseStringSchema<DateTime>

Properties

codaType

codaType: DateTime

Defined in: schema.ts:689

Instructs Superhuman Docs to render this value as a date.

Overrides

BaseStringSchema.codaType

---

dateFormat?

optional dateFormat: string

Defined in: schema.ts:696

A Moment date format string, such as 'MMM D, YYYY', that corresponds to a supported Superhuman Docs date column format, used when rendering the value.

Only applies when this is used as a sync table property.

---

description?

optional description: string

Defined in: schema.ts:286

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

---

timeFormat?

optional timeFormat: string

Defined in: schema.ts:703

A Moment time format string, such as 'HHss', that corresponds to a supported Superhuman Docs time column format, used when rendering the value.

Only applies when this is used as a sync table property.

---

type

type: String

Defined in: schema.ts:809

Identifies this schema as a string.

Inherited from

BaseStringSchema.type