dm-codec
TypeScript icon, indicating that this package has built-in type declarations

2.1.1 • Public • Published

dm-codec

node.js package, wrapper around libdmtx for encoding and decoding datamatrix tags.

Install

This package depends on libdmtx being installed and available on your system. You can find instructions on how to install it here. After that is installed, proceed with...

npm install dm-codec

Note for OSX users: you can alternatively use brew install libdmtx.

Usage

const dmCodec = require("dm-codec");

Encoding

dmCodec.encode("The text to encode in a datamatrix");

It returns an object with the following properties:

  • data: an array of pixels representing the datamatrix tag
  • width: the width of the resulting pixels
  • height: the height of the resulting pixels
  • channels: the channels count of the resulting pixels

Decoding

dmCodec.decode({
  width: colsCount,
  height: rowsCount,
  data: pixels,
  ...otherOptions
});

where data is a Buffer or Uint8Array.

It returns a text or throw an error:

  • text: the content of the datamatrix tag

Readme

Keywords

Package Sidebar

Install

npm i dm-codec

Weekly Downloads

43

Version

2.1.1

License

BSD

Unpacked Size

12.3 kB

Total Files

8

Last publish

Collaborators

  • k.cai