PackagesTypesOverview

@quatrain/types

📦 API Reference: Detailed TypeScript documentation, classes, interfaces, and methods are available in the TypeDoc API Reference for @quatrain/types ↗.

Fundamental type definitions, domain exceptions, and global reference structures (URIs) for the Quatrain Core framework.

Features

  • Object Reference System: The ObjectUri class represents a unique global reference system for all Quatrain models.
  • Resource Exceptions: Contains structured resource exceptions (e.g. NotFoundError, ValidationError, BadRequestError) aligning with standard HTTP responses.
  • Domain Interfaces: Base interfaces mapping system entities (BaseObjectType, ReferenceType).

Getting Started

Refer to HOWTO.md for API and coding examples.

License

AGPL-3.0-only

OverviewHOWTO