TypeScript NUM Record Packer

This program takes a JSON object and convertes it to a more compact JSON object using a mapping specification, also written as JSON.

Running the example code in a web browser

1. Clone the repository using git clone git@github.com:NUMtechnology/num-record-packer.git.
2. cd num-record-packer
3. Run npm install -g webpack
4. Run npm install -g webpack-cli
5. Run npm install
6. Open the test/index.html file using a web browser (Only tested using Brave browser)
7. Paste your JSON into the first two text areas and click Pack to see the result.

Use the Packer in JavaScript

1const api = require('num-record-packer');
2
3const mapperData = {
4  phonetic: {
5    assignKeys: ['a', 'b', 'c'],
6  },
7};
8
9const data = {
10  phonetic: {
11    a: 'alpha',
12    b: 'bravo',
13    c: 'charlie',
14  },
15};
16
17const packed = api.mapper.pack(data, mapperData);
18
19console.log(JSON.stringify(packed));

Use the Packer in TypeScript

1import { createNumRecordPacker } from 'num-record-packer';
2
3const mapperData = {
4  phonetic: {
5    assignKeys: ['a', 'b', 'c'],
6  },
7};
8
9const data: object = {
10  phonetic: {
11    a: 'alpha',
12    b: 'bravo',
13    c: 'charlie',
14  },
15};
16
17const packer = createNumRecordPacker();
18const packed: object = packer.pack(data, mapperData);
19console.log(JSON.stringify(packed));```