Module string

Textual shape model and factories.

Defines shapes and factories for validating textual values, mapping the JSON string type to XSD 1.1 string datatypes.

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

² XSD 1.1 Part 2 § D.3.4 permits optional timezone indicators for gYear as a deviation from ISO 8601

³ Requires exactly 3 fractional second digits (millisecond precision) and UTC timezone (Z only)

Compatibility

Defining String Shapes

import { string } from '@metreeca/blue';

const text = string();                                 // unconstrained string
const name = string({ minLength: 1, maxLength: 100 }); // length-constrained
const code = string({ pattern: /^[A-Z]{3}-\d{4}$/ });  // pattern-constrained
const status = string({ in: ["active", "inactive"] }); // enumeration-constrained
Copy

Specialised String Factories

Predefined factories for common string formats:

import { email, url, uri, date, time, instant, timestamp, duration } from '@metreeca/blue';

const contact = email();      // RFC 5321 email address
const homepage = url();       // RFC 3986 absolute URL
const identifier = uri();     // RFC 3986 absolute URI
const birthday = date();      // ISO 8601 date (YYYY-MM-DD)
const start = time();         // ISO 8601 time (hh:mm:ss)
const created = instant();    // ISO 8601 datetime
const modified = timestamp(); // ISO 8601 timestamp (millisecond precision, UTC)
const validity = duration();  // ISO 8601 duration
Copy

Using in Resource Shapes

import { resource, required, optional, string, email, date } from '@metreeca/blue';

const Person = resource({
  name: required(string({ minLength: 1 })),
  email: optional(email()),
  birthDate: optional(date())
});
Copy