README.adoc

libmmel

Introduction

This library implements serialization and deserialization of MMEL models, and provides exported interfaces for relevant data types.

Note	This model does not contain runtime information. Any such runtime information should be implemented in a separate model.

Installation

Run:

npm install @paneron/libmmel

Usage Examples

import { textToMMEL, MMELToText } from '@paneron/libmmel';
import type { MMELModel } from '@paneron/libmmel';


const text = '... insert MMEL text here ...';
const mmel: MMELModel = textToMMEL(text);
console.log(MMELToText(mmel));

Folder Structure

• interface/

  • Contains the data structures of different elements in the model

• handler/

  • Contains the codes for parsing MMEL structure to MMEL model

• util/

  • Provides other utility functions (Check the comments inside)

Roadmap

• Use pure ESM.