Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

light-characteristics

k-yle36MIT1.0.0TypeScript support: included

🛥️🔦 A parser for light characteristics used on nautical charts

light, lights, light characteristics, s57, seamark, nautical

readme

Light Characteristic Parser

Build Status Coverage Status npm version npm npm bundle size

🛥️🔦 A JavaScript library to encode and decode light characteristics used on nautical charts.

Install

npm install light-characteristics

Usage

import { decodeLight, encodeLight } from 'light-characteristics';

const light = decodeLight('AeroF.RY.5m');
light; // -> { LITCHR: 'F', COLOUR: ['R', 'Y'], HEIGHT: 5, CATLIT: 'aero' }

const encoded = encodeLight({
  LITCHR: 'F',
  COLOUR: ['R', 'Y'],
  HEIGHT: 5,
  CATLIT: 'aero',
});
encoded; // -> 'AeroF.RY.5m'