Interface: SimpleStringSchema<T>¶

A schema whose underlying value is a string, along with an optional hint about how Superhuman Docs should interpret that string.

Extends¶

Type Parameter	Default type
`T` extends `SimpleStringHintTypes`	`SimpleStringHintTypes`

optional codaType: T

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

BaseStringSchema.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.

BaseStringSchema.description

type: String

Identifies this schema as a string.

BaseStringSchema.type