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

keyboard-barcode-scan-listener

v1.0.3

Published

Listen for keyboard sequences and interpret them as a barcode.

Downloads

19

Readme

keyboard-barcode-scan-listener

Build Status

Listen for barcode scan events from keyboard/HID devices in the browser.

Installation

To install via npm:

npm install keyboard-barcode-scan-listener

To install via yarn:

yarn add keyboard-barcode-scan-listener

Usage

To create a basic listener that uses the default input handler:

import createKeyboardBarcodeScanListener from 'keyboard-barcode-scan-listener';

const removeScanListener = createKeyboardBarcodeScanListener({
  onScan: (barcode) => console.log(barcode),
});

// To remove the scan listener, call the function returned by createKeyboardBarcodeScanListener:
removeScanListener();

By default, the scan listener will be attached to window.document and listen on keydown events.

Input Handlers

Most of the brains in keyboard-barcode-scan-listener is in input handlers, which are initialized with the onScan handler and receive keydown events as they are received by the target; they buffer a barcode until it's fully read, at which point they call onScan.

The library ships with two handlers:

  • delimited input: The default handler. Listens for a start character and buffers all input until an end character (by default, F18 and F19, respectively), when it calls onScan with the barcode. By default, it prevents barcode values from becoming input to the page.
  • prefixed input: Listens for a multi-character prefix (or, optionally, no prefix--not recommended!) and when the input passes a test or no input is detected for a certain amount of time, calls onScan with the barcode. Does not (and cannot) prevent barcode values from becoming input to the page.

Both are configurable and well-documented in the source. In general, you should prefer the delimited input handler (the default) if possible as it is more flexible and is capable of preventing scanner keyboard events from being interpreted as regular user keyboard to the page, which is generally undesirable.