HeapTableRepo.schema

JSON-схема полей heap-таблицы.

Предоставляет собой JSON-схему объекта с полями, описанными при объявлении таблицы с помощью Heap.Table.

Может быть использована для чтения мета-информации о полях таблицы и формирования, например, автоматческих форм редактирования записей таблицы с учётом типов полей.

Схема не содержит описания системных полей heap-таблицы, таких как id, heapType и т.п.

Применение/сигнатура

table.schema

• Возвращаемое значение: object
  JSON-схема объекта с полями верхнего уровня таблицы.

Примеры

---

Вывод списка полей таблицы с типами.

const Tasks = Heap.Table('tasks', {
  title: Heap.String(),
  due: Heap.DateTime(),
  basedOn: Heap.GenericLink(),
})

app.screen('task-fields', async ctx => {
  return (
    <screen title="Task Fields">
      {Object.entries(Tasks.schema.properties).map(([fieldName, fieldSchema]) =>
        <list-item
          content={{
            title: fieldName,
            subTitle: fieldSchema.type,
          }}
        />
      }
    </screen>
  )
})