Module number

Numeric shape and factories.

Defines shapes and factories for validating numeric values, mapping the JSON number type to XSD 1.0 numeric datatypes.

Factories validate constraint consistency at construction time: contradictory constraints like minInclusive > maxInclusive throw a RangeError.

¹ XSD 1.0 datatypes are referenced by RDF 1.1 and JSON-LD 1.1 as normative

² Numeric types with ranges exceeding JavaScript's safe integer range (±2⁵³-1) or requiring arbitrary precision cannot be fully represented in JSON/JavaScript

Compatibility

Defining Numeric Shapes

import { number, integer, decimal } from '@metreeca/blue/number';

const count = number();                                       // default model: 0
const score = number({ minInclusive: 0, maxInclusive: 100 }); // constrained range
const age = integer({ minInclusive: 0 });                     // arbitrary-precision integer
const price = decimal({ minInclusive: 0 });                   // arbitrary-precision decimal
Copy

Typed Numeric Factories

Specialised factories map to XSD numeric datatypes with predefined precision:

import { byte, short, int, long, float, double } from '@metreeca/blue/number';

const priority = byte();       // 8-bit signed integer
const port = short();          // 16-bit signed integer
const quantity = int();        // 32-bit signed integer
const offset = long();         // 64-bit signed integer
const ratio = float();         // IEEE 754 single-precision
const measurement = double();  // IEEE 754 double-precision
Copy

Using in Resource Shapes

import { required, optional } from '@metreeca/blue/value';
import { resource } from '@metreeca/blue/resource';
import { integer, decimal } from '@metreeca/blue/number';

const Product = resource({
  price: required(decimal({ minInclusive: 0 })),
  quantity: optional(integer({ minInclusive: 0 })),
  rating: optional(decimal({ minInclusive: 0, maxInclusive: 5 }))
});
Copy