Heap.Money

Объявляет поле типа Money.

Это нестандартный тип в JSON-схеме. Он хранится в БД в виде пары (tuple) [сумма, код валюты], а в рантайме предствален экземпляром специального класса Money. Подробнее о работе с денежными полями можно почитать в соответствующем разделе руководства.

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

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

Аргументы

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

  • default: [number, string]
    Значение по умолчанию для данного поля только в формате пары [сумма, международный код валюты]. Подробнее о том, как работают значения по умолчанию, см. Руководство / Heap / Значения по умолчанию

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

JSON-схема для array-поля с двумя элементами, первый - число, второй - трёхбуквенная строка.

Примеры

Денежное поле со значение по умолчанию 0$

const products = Heap.Table('products', {
  price: Heap.Money({ default: [0, 'USD'] }),
})