{"id":15954,"library":"apg-conv-api","title":"APG Converter API","description":"apg-conv-api is a JavaScript library that provided an API for converting integer arrays to encoded byte streams (Node.js Buffers) and vice versa. It also exposed low-level transformation functions for encoding and decoding, and was bundled for use in both Node.js and browser environments. The package is officially deprecated as of version 1.0.1, with its functionality superseded by `apg-js`. Developers are strongly advised to migrate to `apg-js` for ongoing support and new features. The package's release cadence was tied to its companion `apg-conv` library, but is now effectively halted due to its deprecated status. Its key differentiator was providing direct programmatic access to the `apg-conv` core conversion logic for various data types.","status":"deprecated","version":"1.0.1","language":"javascript","source_language":"en","source_url":null,"tags":["javascript"],"install":[{"cmd":"npm install apg-conv-api","lang":"bash","label":"npm"},{"cmd":"yarn add apg-conv-api","lang":"bash","label":"yarn"},{"cmd":"pnpm add apg-conv-api","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"This package is the API layer for apg-conv, requiring it for the core conversion logic.","package":"apg-conv","optional":false}],"imports":[{"note":"Primary import for Node.js CommonJS environments. This package does not support ESM imports.","wrong":"import apgConv from 'apg-conv-api';","symbol":"apgConv","correct":"const apgConv = require('apg-conv-api');"},{"note":"Accessing specific utility functions from the `converter` object after requiring the main module.","wrong":"import { converter } from 'apg-conv-api';","symbol":"apgConv.converter.decode","correct":"const { converter } = require('apg-conv-api');\nconst decoded = converter.decode(\"UTF8\", chars);"},{"note":"In browser environments, including the script tag exposes `apgConv` as a global object.","symbol":"apgConv (global in browser)","correct":"<!-- In HTML -->\n<script src=\"./apg-conv-api.js\"></script>\n<script>\n  const buf = apgConv.converter.decode(\"UTF8\", chars);\n</script>"}],"quickstart":{"code":"const apgConv = require('apg-conv-api');\n\n// Example: Define some characters (e.g., Unicode code points)\nconst chars = [0x41, 0x42, 0x43, 0xE2, 0x82, 0xAC]; // 'ABC€' in UTF-8 code points\n\nconsole.log('Original character array:', chars);\n\n// Encode to a Buffer (UTF8)\nconst buffer = apgConv.converter.encode('UTF8', chars);\nconsole.log('Encoded Buffer:', buffer);\nconsole.log('Buffer as string:', buffer.toString('utf8'));\n\n// Decode back to an array of integers (UTF8)\nconst decodedChars = apgConv.converter.decode('UTF8', buffer);\nconsole.log('Decoded character array:', decodedChars);","lang":"javascript","description":"Demonstrates how to use `apg-conv-api` to encode an array of integer code points into a Node.js Buffer and then decode it back using UTF8 encoding."},"warnings":[{"fix":"Replace `apg-conv-api` with `apg-js`. Refer to the `apg-js` documentation and `apg-js-examples` for updated usage patterns.","message":"The `apg-conv-api` package is officially deprecated. Users should migrate to `apg-js` for all current and future development.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"For Node.js, continue using `require()`. For modern applications requiring ESM, migrate to `apg-js` which offers ESM compatibility.","message":"This package is designed for CommonJS (Node.js `require`) and global browser usage. It does not provide native ES Module (ESM) support.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Migrate to the actively maintained `apg-js` package to ensure ongoing compatibility and receive critical updates.","message":"Future compatibility with newer Node.js versions or browser environments is not guaranteed due to the package's deprecated status and lack of maintenance.","severity":"breaking","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-21T00:00:00.000Z","next_check":"2026-07-20T00:00:00.000Z","problems":[{"fix":"Ensure `const apgConv = require('apg-conv-api');` is at the top of your Node.js file, or that the script tag for `apg-conv-api.js` is included in your HTML before calling `apgConv` in a browser.","cause":"Attempting to use `apgConv` without properly requiring or including it, or using an incorrect symbol name.","error":"TypeError: apgConv.converter.decode is not a function"},{"fix":"This package is CommonJS-only. If you are in an ES Module environment, you must either use a dynamic `import()` or, preferably, migrate to the `apg-js` package which offers ES Module support.","cause":"Trying to `require()` an ES Module or using `import` syntax with this CommonJS-only package.","error":"ERR_REQUIRE_ESM: require() of ES Module ... not supported"}],"ecosystem":"npm"}