npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

zebra-crossing

v0.1.2

Published

A wrapper around zxing's CLI that lets you read barcodes

Downloads

1,960

Readme

ZebraCrossing

ZebraCrossing is a wrapper around the zxing CLI. It supports all sensible options of the zxing CLI and lets you pass buffers as well as file paths (but see the note on this).

It's still not fast, it still a bit hacky, it's still your best bet for reading barcodes.

const ZebraCrossing = require('zebra-crossing');
ZebraCrossing.read(fs.readFileSync('image.png'), { pureBarcode: true })
	.then(data => console.log(data));

Example output:

{
	raw: Buffer.from('Hello world!'),
	parsed: Buffer.from('Hello world!'),
	format: 'QR_CODE',
	type: 'TEXT',
	points: [ [774.0,461.0], [774.0,405.0], [830.0,405.0] ]
}

Requirements

The dirty work of actually parsing the barcodes is done by zxing, a Java library, so you'll need to have a Java Runtime Environment installed.

API

ZebraCrossing only has one method: read(file<String|Buffer>, [options]).

If file is a string, it will be assumed to be a file path that will be passed to zxing. If file is a buffer, its contents will be written to a temporary file whose path will be passed to zxing.

options can be an object like this:

{
  // Use the TRY_HARDER hint
  tryHarder: true,
  // Image is a direct monochrome image of a barcode, not a photo
  pureBarcode: true,
  // Only read retail barcodes (EAN and UPC)
  productsOnly: true,
  // Find multiple barcodes in the same image
  multi: true,
  // Crop by the specified pixel values before searching for barcodes
  crop: { left: 10, top: 20, width: 30, height: 40 },
  // Only search for the specified barcode formats
  // See ZebraCrossing.FORMAT for supported formats
  possibleFormats: [ 'AZTEC', 'QR_CODE' ],
}

ZebraCrossing.read() returns a Promise that resolves with a { raw, parsed, format, type, points } object if a barcode was found or null if none was found. If multi: true was set in the options, it resolves with an array of result objects, or the empty array if no barcodes were found.

A note on file paths

Because zxing's CLI only accepts file paths, buffers are written to a temporary file on disk before they're parsed. This means that you should always pass a file path if you can. Accepting buffers is just for your convenience.