apg-conv-apiDeprecated: 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
It also provides access to the low-level transformation functions which actually do the encoding and decoding. These can be found in the
node.js applicationsIn 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 applicationsapg-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>
apgConv.convert() apgConv.encode() apgConv.decode() apgConv.transfomers apgConv.Buffer
Besides the high-level conversion, encoding and decoding functions,
apgConv.transformersgives access to all of the low-level functions.
apgConv.Bufferis the node.js
Bufferobject for convenience.
For examples of both
node.jsand HTML usage, see these examples.
Documentation:The documentation is in the code in
doccoformat. To generate the documentation, from the apg-conv-api package directory:
npm install -g docco ./docco-gen
docs/index.htmlin any web browser to get started.
Copyright © 2017 Lowell D. Thomas, all rights reserved
Released with the BSD-3-Clause license.