Interface IntegerOptions

The options for an Integer:

  • round?: 'floor' | 'ceil' | 'round' | 'deny' - how should the number be rounded
  • min?: number - minimum allowed number
  • max?: number - maximum allowed number

Hierarchy

Properties

max? min? name? round?

Properties

Optional max

max?: number

the upper bound of the interval the value has to be in

Optional min

min?: number

the lower bound of the interval the value has to be in

Optional name

name?: string

the name of the ValueObject to identify in a possible ErrorMessage.

  • eg: 'MealPlan.price'

Optional round

round?: "round" | "floor" | "ceil" | "deny"

how should the number be rounded.

  • defaults to 'deny' which causes the validate() method to throw an error if the number has decimal places.

Theme

Generated using TypeDoc