# @signalk/signalk-schema > SignalK specification schema as an npm module with tests Latest version **1.8.2** (published 2026-02-09) · CC-BY-SA-2.0 license · 0 weekly downloads ## Install ```sh npm install @signalk/signalk-schema pnpm add @signalk/signalk-schema yarn add @signalk/signalk-schema bun add @signalk/signalk-schema ``` Provides the command `signalk-validate-full`. ## Health **Score 45/100 (D)** — status: stable. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 1.8.2 | | Published | 2026-02-09 | | First published | 2017-08-09 | | Weekly downloads | 0 | | License | CC-BY-SA-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 680.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 104 | | Author | SignalK group | | Maintainers | tkurki, sbender, panaaj | | Keywords | signalk, nmea, marine, navigation, n2k, nmea200 | ## Links - npm: https://www.npmjs.com/package/@signalk/signalk-schema - Repository: https://github.com/SignalK/specification - Issues: https://github.com/SignalK/specification/issues - Funding: https://opencollective.com/signalk - npm.io page: https://npm.io/package/@signalk/signalk-schema ## Dependencies (6) - [tv4](https://npm.io/package/tv4.md) ^1.2.7 - [debug](https://npm.io/package/debug.md) ^4.3.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [JSONStream](https://npm.io/package/JSONStream.md) ^0.7.4 - [tv4-formats](https://npm.io/package/tv4-formats.md) ^3.0.3 - [@apidevtools/json-schema-ref-parser](https://npm.io/package/@apidevtools/json-schema-ref-parser.md) ^9.1.0 ## Alternatives - [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads - [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads - [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads - [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads - [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads ## Recent versions - 1.8.2 (latest) — 2026-02-09 - 1.8.1 — 2026-02-08 - 1.8.0 — 2026-02-07 - 1.7.2 — 2024-01-04 - 1.7.1 — 2023-03-14 - 1.6.0 — 2021-03-27 - 1.5.1 — 2020-11-23 - 1.5.0 — 2020-07-10 - 1.3.1 — 2019-06-06 - 1.1.1 — 2018-10-20 - 1.1.0 — 2018-10-18 - 1.0.3 — 2018-01-08 - 1.0.2 — 2018-01-02 - 1.0.1 — 2018-01-01 - 1.0.0 — 2018-01-01 - … 8 more at https://npm.io/package/@signalk/signalk-schema/versions ## README Signal K Specification ====================== See the [latest published version](http://signalk.org/specification/). This repository contains the (working) specification for Signal K, defined in JSON Schema files, tests for the schema files and assorted JavaScript utilities for working with Signal K delta and full JSON data as well as validation utilities. [![Build Status](https://travis-ci.org/SignalK/specification.svg?branch=master)](https://travis-ci.org/SignalK/specification) [![Slack Chat](https://img.shields.io/badge/Chat-Slack-ff69b4.svg "Join us and help develop Signal K. Anyone is welcome!")](http://slack-invite.signalk.org/) Signal K -------- The Free and Open Source universal marine data exchange Signal K is about publishing a common modern and open data format for marine use. A format for the modern boat, compatible with NMEA, friendly to WiFi, cellphones, tablets, and the Internet. A format available to everyone, where anyone can contribute. Find out more at [signalk.org](http://signalk.org). Then join the mailinglist by sending an email to signalk+subscribe@googlegroups.com or follow the discussion via the Signal K Google Groups forum. Version 2 -------- We have started [gathering thoughts as well as actual work on version 2](https://github.com/SignalK/specification/blob/master/v2-food-for-thought.md). Usage ----- The `master` branch contains the latest version of the Schema. When making changes, please clone this repo to your local machine and set up a new branch (`git checkout -b branch_name`). Send in a pull request for every change, put it up for discussion in the mailing list and then (when a consensus has been reached) merge it into `master`. The `gh-pages` branch contains the currently published version of the schema and specification. Documentation is generated with Gitbook and published at http://signalk.org/specification/master/. Documentation is published on the web with a single npm command: ``` $ npm run docs:publish ``` See below for details. Gitbook Documentation --------------------- The documentation .md sources are at https://github.com/SignalK/specification/tree/master/gitbook-docs. Requires separate installation of `ebook-convert`, see https://toolchain.gitbook.com/ebook.html. - `npm run docs:serve` for local preview - `npm run docs:all` to generate locally - `npm run docs:publish` to publish in gh-pages. The changelog in the documentation is generated based on Github Pull Requests. For things to show up in the changelog you MUST USE PRs! Rewording is possible by rewriting PR titles. Validation ---------- Validation against Signal K schema can be done - with a command line validator accepting JSON from stdin - by explicitly calling validate packaged as an npm module - by using a Chai assertion, available in the npm module ``` cat test/data/full-invalid/vessel-mmsi_bad.json | bin/validate.js { "errors": [ { "message": "String does not match pattern: ^[2-7][0-9]{8}$", "params" .....etc ``` ```javascript var validate = require('signalk-schema').validate; var result = validate(msg); result.errors.forEach(function(error) { console.error(error.message + ':' + error.dataPath); }); ``` ```javascript chai.use(require('signalk-schema').chaiModule); tree.should.be.validSignalK; ``` --- _Source: https://npm.io/package/@signalk/signalk-schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._