Skip to content

overture-stack/js-lectern-client

Repository files navigation

Deprecation Notice

This version of the Lectern client is considered deprecated. The officially supported version has been moved to @overture-stack/lectern-client alongside the other Overture.bio software packages.

The Lectern client codebase has also been moved. To contribute to the ongoing development of Lectern tools please go to github.com/@overture-stack/lectern.

JS Lectern Client

Features:

  • Runs different restrictions validations: regex, range, scripts, required fields, type checks, etc.
  • Transforms the data from string to their proper type.
  • Report validation errors.
  • Fetch dictionaries from the configured lectern service.
  • Provide typed definitions for the dictionary object.
  • Analyze dictionary versions diff.

Usage examples:

to release new version

  • bump the version number

  • publish to npm and tag git: Jenkinsfile will do that when a commit is added to master. if you need to do that manually then run npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}" && npm publish