Ortac Specification

This project sets out the Ortac specification and exports various components which form part of the specification into both both CommonJS and ESM packages from a common Typescript ESM codebase.

Includes testing, coverage, coveralls.io, linting, TSDoc and auto creation of a package on creating a github release.

Install

> npm install @ortac/specification

Features

• Works with CommonJS and ESM
• Provides Typescript types
• Provides JSON Schemas for each file format as js objects
• Provides TypeScript Type Guard functions for all file formats using JSON Schema checking (ajv)
• Produces a set of ZIP files which are available on Github for each release version

Usage

ESM:

import * as ortac from '@ortac/specification';

console.log(ortac.schemas.locale.V1_0_0);

CommonJS:

var ortac = require('@ortac/specification');

console.log(ortac.schemas.locale.V1_0_0);

Documentation

Documentation can be found here

An explanation of everything produced by this project is here