Heap.String

Объявляет поле типа string (строка в кодировке utf-8).

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

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

Аргументы

options: {default, minLength, maxLength,
format, pattern}
Объект с дополнительными необязательными параметрами поля.
- default: string
  Значение по умолчанию для данного поля. Подробнее о том, как работают значения по умолчанию, см.
  Руководство / Heap / Значения по умолчанию
- minLength: number
  Минимальная длина строки.
- maxLength: number
  Максимальная длина строки.
- format: "date-time" | "email"
  Втроенный валидатор формата строки согласно спецификации JSON-schema. Поддерживаются только 2 формата:
  date-time и email.
- pattern: string
  Регулярное выражение, которому должна соответствовать строка. Выражение должно быть представлено в виде
  обычной строки, а не экземпляра класса
  RegExp,
  без слешей в начале и конце и без флагов. Флаги регулярных выражений (например i - игнорировать регистр)
  валидатором не поддерживаются. При валидации подставляется только флаг u - поддержка юникода.

Возвращаемое значение

JSON-схема для string-поля.

Примеры

Любая строка

const orgs = Heap.Table('orgs', {
  name: Heap.String(),
})

Любой валидный email-адрес

const customers = Heap.Table('customers', {
  email: Heap.String({ format: 'email' }),
})

Строка состоящая только из строчных латинских символов длиной ровно 32 символа

const products = Heap.Table('products', {
  partno: Heap.String({
    pattern: '^[a-z]*$',
    minLength: 32,
    maxLength: 32,
  }),
})

Предложить изменения