Skip to content

Interface: SimpleStringSchema<T>

Defined in: schema.ts:829

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

Extends

  • BaseStringSchema<T>

Type Parameters

Type Parameter Default type
T extends SimpleStringHintTypes SimpleStringHintTypes

Properties

codaType?

optional codaType: T

Defined in: schema.ts:809

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

Inherited from

BaseStringSchema.codaType


description?

optional description: string

Defined in: schema.ts:285

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


type

type: String

Defined in: schema.ts:807

Identifies this schema as a string.

Inherited from

BaseStringSchema.type