PositiveNumber

Number value object constrained to non-negative values.

Import

import { PositiveNumber } from '@haskou/value-objects';

Signature

class PositiveNumber extends NumberValueObject

Constructor

constructor(value: number | NumberValueObject)

Validation

The current implementation accepts values greater than or equal to 0.

Throws

This class can throw:

• InvalidPositiveNumberError
• InvalidNumberError

Example

import { PositiveNumber } from '@haskou/value-objects';

const amount = new PositiveNumber(0);
const price = new PositiveNumber(19.99);

price.isGreaterThan(amount); // true

Notes

• Despite the class name, the current implementation accepts 0.
• Arithmetic methods are inherited from NumberValueObject.

Related

• Error handling
• Reference overview