apg-conv-api v1.0.1

apg-conv-api

Deprecated: Use apg-js instead. See apg-js-examples for usage.

apg-conv-api is the API for apg-conv. It provides the functions for disassembling the data types as well as the encoding and decoding functions. These can be found in the ./src/converter.js file.

It also provides access to the low-level transformation functions which actually do the encoding and decoding. These can be found in the ./src/transformers.js file.

node.js applications

In your project directory:

npm install apg-conv --save

In your application code, for example:

var apgConv = require("apg-conv-api");
var buf = apgConv.converter.decode("UTF8", chars);

HTML applications

apg-conv-api has been bundled (with webpack) for use in web page applications. Use one of the script links:

<script src="./apg-conv-api.js"></script>
or
<script src="./apg-conv-api-min.js"></script>

This will give you access to apg-conv-api in your web page JavaScript through the functions and objects:

apgConv.convert()
apgConv.encode()
apgConv.decode()
apgConv.transfomers
apgConv.Buffer

Besides the high-level conversion, encoding and decoding functions, apgConv.transformers gives access to all of the low-level functions.

apgConv.Buffer is the node.js Buffer object for convenience.

For examples of both node.js and HTML usage, see these examples.

Documentation:

The documentation is in the code in docco format. To generate the documentation, from the apg-conv-api package directory:

npm install -g docco
./docco-gen

View docs/index.html in any web browser to get started.

Copyright:
Copyright © 2017 Lowell D. Thomas, all rights reserved

License:
Released with the BSD-3-Clause license.