Generate 50+ different 1D or 2D barcodes in png, eps, or svg format.

• 1. Introduction
• 2. Installation
• 3. Usage
  • 3.1. Import the module
  • 3.2. Struct
  • 3.3. Available functions
    • 3.3.1. Render a base64 png
    • 3.3.2. Render a file
• 4. Available options (struct)
• 5. Error handling
• 6. Symbology types
• 7. Development
  • 7.1. Building
  • 7.2. Testing
  • 7.3. Packaging
  • 7.4. Bugs
  • 7.5. Changelog
• 8. Credits
• 9. License

This 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. It can save a png, svg, or eps image, or render a base64 png bitmap.

symbology can be downloaded directly or installed via npm.

npm install symbology --save

var symbology = require('symbology');

Prepare a Symbol json object with your desired settings (see 4. Available options (struct) for more info):

var Symbol = {
  symbology: symbology.Barcode.CODE128,
  foregroundColor: 'fff000',
  backgroundColor: '000000',
  fileName: '/my/directory/barcode.png'
};

Each function returns a promise that completes with an object containing the exit code and message of the function (see 5. Error handling for more info).

createStream(Symbol, data, type)

Writes a base64 string to the output object in a property data.

symbology
  .createStream(Symbol, '12345')
  .then(function(data) {
    console.log('Result: ', data);
  }, function(err) { 
    console.log('Error: ', err); 
  });

Returns:

Result: { 
  message: '',
  code: 0,
  data: 'data:image/png;base64,iVBOR [...] g==' 
}

createFile(Symbol, data)

Writes a stream in to the output object in a property data.

symbology
  .createFile(Symbol, '12345')
  .then(function(data) {
    console.log('Result: ', data);
  }, function(err) { 
    console.log('Error: ', err); 
  });

This creates a file in the specified fileName and will log:

Result: { 
  message: '',
  code: 0,
  fileName: 'barcode.png'
}

A Symbol is a regular JavaScript object with the following available properties:

* required only if using createFile.

Each function returns an object having property code, which is the status code of the function, and message, which contains an error/warning message (if any).

Below are the possible status codes:

There are 53 different available symbology types. For an exhaustive list, please see the Barcode Types list.

To compile the latest, ensure you have node-pre-gyp installed. Then run:

npm run build

npm test

npm run package-binary

Replace report all bugs here.

Available here.

This library is a JS/C++ wrapper module for the terrific C/C++ library Zint, (C) Robin Stuart. Module by Josh Shor.

MIT.