Skip to content

Interface: NumericTimeSchema

Defined in: schema.ts:354

A schema representing a return value or object property that is provided as a number, which Superhuman Docs should interpret as a time. The given number should be in seconds since the Unix epoch. While this is a full datetime, only the time component will be rendered, so the date used is irrelevant.

Extends

  • BaseNumberSchema<Time>

Properties

codaType

codaType: Time

Defined in: schema.ts:356

Instructs Superhuman Docs to render this value as a time.

Overrides

BaseNumberSchema.codaType

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

BaseNumberSchema.description

format?

optional format: string

Defined in: schema.ts:363

A Moment time format string, such as 'HH🇲🇲ss', 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: Number

Defined in: schema.ts:315

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type