Jsonotron-schemas NPM

A library of schemas used by the Jsonotron system.

A library of schemas used by the Jsonotron system to validate document types, field types and role types.

The schemas allow the use of functions to be added to the JS objects via the customTypeOf keyword. For example, on a document type, the implementation of a constructor can be included in the definition because of the following definition:

ctor: {
  type: 'object',
  description: 'A mechanism for constructing new instances of the document type.',
  additionalProperties: false,
  properties: {
    parameters: { /* edited out */ }
    implementation: { customTypeOf: 'function' } // <-- function inline with the JSON Schema.
  },
  required: ['parameters', 'implementation']
}

This package is part of the Jsonotron system.
Jsonotron is...
a small set of components for building a NodeJS microservice
for storing, patching and querying JSON documents
stored in a schemaless/NoSQL database
that have known, enforceable, and evolving schemas.
Visit https://karlhulme.github.io/jsonotron/ for details on how to get started.

Installation

npm install jsonotron-schemas --save

Usage

const { docTypeSchema, fieldTypeSchema, roleTypeSchema } = require('jsonotron-schemas')

console.log(docTypeSchema)
console.log(fieldTypeSchema)
console.log(roleTypeSchema)