# Interface: BooleanSchema

Defined in: [schema.ts:291](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L291)

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

## Extends

- `BaseSchema`

## Properties

### codaType?

> `optional` **codaType**: [`Toggle`](../../enumerations/ValueHintType/#toggle)

Defined in: [schema.ts:295](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L295)

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

______________________________________________________________________

### description?

> `optional` **description**: `string`

Defined in: [schema.ts:285](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L285)

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`](../../enumerations/ValueType/#boolean)

Defined in: [schema.ts:293](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L293)

Identifies this schema as relating to a boolean value.