![](\"https://symbology.dev/assets/hero.svg\")
\n \n\n \n \n \n \n\n
A Node.js module that generates barcode images. Supports 50+ different 1D or 2D symbologies in png, eps, or svg formats.
\n\n\n\n## Introduction\n\nThis Node.js module will allow you to generate over 50+ different types of 1D or 2D symbologies, including barcodes for books, grocery, shipping carriers, healthcare, and international codes.\n\nIt can create a PNG, SVG, or EPS image file, or return a string containing SVG, PostScript, or base64-encoded PNG data.\n\n## Documentation\n\n[Read the docs →](https://symbology.dev/docs/)\n\n## Quick start\n\n```sh\nyarn add symbology\n```\n\n## Quick Examples\n\n### Code 11 Example\n\n```ts\nimport { SymbologyType, createStream } from 'symbology'\n\n(async () => {\n const { data } = await createStream({\n symbology: SymbologyType.CODE11\n }, '8765432164')\n\n console.log('Result: ', data)\n})()\n```\n\nThis will log:\n\n```json\n{\n \"data\": \"data:image/png+data;base64,PHN [...] eFd==\",\n \"message\": \"Symbology successfully created.\",\n \"code\": 0\n}\n```\n\nAnd the base64 PNG generated will look like:\n\n\n\n### MaxiCode Example\n\n```ts\nimport { SymbologyType, createFile } from 'symbology'\n\n(async () => {\n const { data } = await createFile({\n symbology: SymbologyType.MAXICODE,\n option1: 2,\n primary: '999999999840012',\n fileName: 'maxiCodeExample.svg'\n }, 'Secondary Message Here')\n\n console.log('Result: ', data)\n})()\n```\n\nThis creates `maxiCodeExample.svg` which looks like:\n\n\n\n### USPS Example\n\n```ts\nimport { SymbologyType, createFile } from 'symbology'\n\n(async () => {\n const { data } = await createFile({\n symbology: SymbologyType.ONECODE\n fileName: 'uspsExample.eps'\n }, '01234567094987654321-01234')\n\n console.log('Result: ', data)\n})()\n```\n\nThis creates `uspsExample.eps` which looks like:\n\n\n\n## License\n\n[GPL-3](LICENSE.md).\n","readmeFilename":"README.md"}