Skip to content

Interface: BooleanSchema

Defined in: schema.ts:291

A schema representing a return value or object property that is a boolean.

Extends

  • BaseSchema

Properties

codaType?

optional codaType: Toggle

Defined in: schema.ts:295

Indicates how to render values in a table. If not specified, renders a checkbox.


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

BaseSchema.description


type

type: Boolean

Defined in: schema.ts:293

Identifies this schema as relating to a boolean value.