Interface: SimpleStringSchema<T>¶
A schema whose underlying value is a string, along with an optional hint about how Coda should interpret that string.
Type parameters¶
Name | Type |
---|---|
T |
extends SimpleStringHintTypes = SimpleStringHintTypes |
Hierarchy¶
BaseStringSchema
<T
>
↳ SimpleStringSchema
Properties¶
codaType¶
• Optional
codaType: T
An optional type hint instructing Coda about how to interpret or render this value.
Inherited from¶
BaseStringSchema.codaType
Defined in¶
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
Defined in¶
type¶
• type: String
Identifies this schema as a string.
Inherited from¶
BaseStringSchema.type