Heap.Number и Heap.Integer

Объявляет поле типа number. Heap.Integer аналогичен Heap.Number, но дополнительно валидирует значение на целочисленность.

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

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

Аргументы

• options: {default, minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf}
  Объект с дополнительными необязательными параметрами поля.

  • default: number
    Значение по умолчанию для данного поля. Подробнее о том, как работают значения по умолчанию, см. Руководство / Heap / Значения по умолчанию
  • minimum: number
    Валидация на минимальное значение. Правило "больше либо равно".
  • maximum: number
    Валидация на максимальное значение. Правило "меньше либо равно".
  • exclusiveMinimum: number
    Правило "строго больше".
  • exclusiveMaximum: number
    Правило "строго меньше".
  • multipleOf: number
    Валидация на кратность заданному числу.

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

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

Примеры

Любое число

const reports = Heap.Table('reports', {
  relativeChange: Heap.Number(),
})

Любое натуральное число

const counters = Heap.Table('counters', {
  count: Heap.Integer({ minimum: 1 }),
})

Целое число кратное 100 меньше 1000

const bets = Heap.Table('bets', {
  amount: Heap.Number({ multipleOf: 100, exclusiveMaximum: 1000 }),
})