Heap.Boolean

Declares a field of type boolean.

Usage / Signature

import { Heap } from '@app/heap'
Heap.Boolean(options)

Arguments

• <b id="options">options</b>: { default }
  An object with additional optional parameters for the field.

  • <b id="default">default</b>: boolean
    The default value for this field. For more information on how default values work, see Guide / Heap / Default Values

Return Value

JSON schema for the boolean field.

Examples

Boolean field with a default value of false

const tasks = Heap.Table('tasks', {
  done: Heap.Boolean({ default: false }),
})