@ts4ocds/core/value/value.ts

TS4OCDS is a library of TypeScript entities that takes an approach to befriend large OCDS JSONs with your per-project routine of writing whole lotta interfaces for them.

/**
 * @packageDocumentation
 * @module Standard.Value
 */

import { Initializable } from '@ts4ocds/utils';

import type { Currency } from './currency';

/**
 * Financial values should be published with a {@link Currency | currency} attached.
 */
export class Value extends Initializable<Value> {
  /**
   * Amount as a number.
   */
  public amount?: number;

  /**
   * The {@link Currency | currency} of the amount,
   * from the closed [currency](https://standard.open-contracting.org/1.1/en/schema/codelists/#currency) codelist.
   */
  public currency?: Currency;
}