jsonotron-builtin-field-types-docs-en v1.0.3

A library of field type definitions included with the Jsonotron engine

The english documentation for all the field types built in to the Jsonotron engine.

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-builtin-field-types-docs-en --save

Usage

const { builtinFieldTypeDocsEN, builtinCategoryDocsEN } = require('jsonotron-builtin-field-types')

const doc = builtinFieldTypeDocsEN.find(fieldType => fieldType.name === 'shortString')
console.log(doc.title) // outputs 'Short String'
console.log(doc.paragraphs) // an array of simplified markdown that describes the field type
console.log(doc.examples) // an array of objects (value, [paragraphs]) that show how to use the field type within documents

const cat = builtinCategoryDocsEN.find(category => category.name === 'text')
console.log(cat.title) // outputs 'Text'
console.log(cat.order) // outputs 10

Development

Code base adheres to the rules chosen by https://standardjs.com/. Code is formatted with 2 spaces.

Tests are written using Jest with 100% coverage.

npm test

Continuous Deployment

Any commits to master will cause the library to be re-published.