@lzcontest/cabrillo

Typed Cabrillo parsing, import, export, and profile contracts for contest logs.

Install

npm install @lzcontest/cabrillo

Parse and serialize

import {
  fieldsByTag,
  parseCabrillo,
  serializeCabrilloDocument,
} from '@lzcontest/cabrillo';

const document = parseCabrillo(
  'START-OF-LOG: 3.0\r\nCALLSIGN: LZ9S\r\nEND-OF-LOG:\r\n',
);
const callsign = fieldsByTag(document, 'CALLSIGN')[0]?.value;
const text = serializeCabrilloDocument(document);

console.log(callsign); // LZ9S
console.log(text);

Core API

| Export | Purpose | | --- | --- | | parseCabrillo | Parse Cabrillo text with line endings and diagnostics | | serializeCabrilloDocument | Serialize a parsed Cabrillo document | | fieldsByTag | Select header fields by tag | | readCabrilloContestName | Read the CONTEST header without a full import | | importCabrillo | Convert a document into a log import draft | | exportCabrillo | Export log QSOs through a Cabrillo profile | | CabrilloProfile | Headers, categories, modes, exchange, and QSO layout |

License

AGPL-3.0-only