barcode-detector - GitLite

KO | EN

gitlite — search

#python #ai #golang #deep-learning #nodejs #java #windows #cli #vue #awesome-list #security #ios #mcp #open-source

barcode-detector

(★ 232)

A Barcode Detection API ponyfill/polyfill that uses ZXing-C++ WebAssembly under the hood.

File Explorer

Download Latest Version (.zip)

- config.json
- README.md
- - preview-release.yml
  - release.yml
  - test.yml
- extensions.json
- settings.json
- barcode-detector.png
- build-cjs.ts
- build-iife.ts
- core.ts
- index.ts
- polyfill.ts
- ponyfill.ts
- utils.ts
- vite-env.d.ts
- zxing-exported.ts
- - broken.png
  - broken.webm
  - cats-dogs.png
  - cats-dogs.webm
  - zero-size.svg
- - areCats.ts
  - areCatsAndDogs.ts
  - drawImageToCanvas.ts
  - getBlob.ts
  - getCanvas.ts
  - getDomImageBitmap.ts
  - getDomOffscreenCanvas.ts
  - getHtmlImage.ts
  - getIframeBlob.ts
  - getIframeCanvas.ts
  - getIframeHtmlImage.ts
  - getIframeImageBitmap.ts
  - getIframeImageData.ts
  - getIframeOffscreenCanvas.ts
  - getIframeSvgImage.ts
  - getIframeVideo.ts
  - getIframeVideoFrame.ts
  - getImageBitmap.ts
  - getImageData.ts
  - getOffscreenCanvas.ts
  - getSvgImage.ts
  - getVideo.ts
  - getVideoFrame.ts
  - messageData.ts
  - seekTo.ts
- barcode-detector.spec.ts
- consts.ts
- globalSetup.ts
- index.html
- polyfill.spec.ts
- worker.ts
.commitlintrc.json
.gitignore
.lintstagedrc.json
.node-version
.prettierignore
.prettierrc
.simple-git-hooks.json
biome.json
CHANGELOG.md
index.html
LICENSE
main.ts
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
renovate.json
tsconfig.base.json
tsconfig.json
tsconfig.node.json
vite.config.ts

# Installation Guide

1. Get the code

git clone https://github.com/Sec-ant/barcode-detector

Downloads the entire project code from GitHub to your computer.

cd barcode-detector

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i barcode-detector

Type this command into your terminal and run it.

src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/polyfill.min.js"

Type this command into your terminal and run it.

import { BarcodeDetector } from "https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/ponyfill.min.js";

Type this command into your terminal and run it.

"barcode-detector/ponyfill": "https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/ponyfill.min.js"

Type this command into your terminal and run it.

<script src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/iife/ponyfill.min.js"></script>

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# barcode-detector

[![npm](https://img.shields.io/npm/v/barcode-detector)](https://www.npmjs.com/package/barcode-detector/v/latest) [![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/barcode-detector)](https://www.npmjs.com/package/barcode-detector/v/latest) [![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/npm/hm/barcode-detector?color=%23ff5627)](https://cdn.jsdelivr.net/npm/barcode-detector@latest/)

A [Barcode Detection API](https://wicg.github.io/shape-detection-api/#barcode-detection-api) ponyfill/polyfill that uses [ZXing-C++ WebAssembly](https://github.com/Sec-ant/zxing-wasm) under the hood.

Supported barcode formats:

<div align="center">

|   Linear Barcode Formats   | Matrix Barcode Formats | Special Barcode Formats |
| :------------------------: | :--------------------: | :---------------------: |
|         `codabar`          |        `aztec`         |     `other_barcode`     |
|         `code_39`          |      `aztec_code`      |   `linear_codes`[^2]    |
|     `code_39_standard`     |      `aztec_rune`      |   `matrix_codes`[^3]    |
|     `code_39_extended`     |     `data_matrix`      |     `gs1_codes`[^4]     |
|         `code_32`          |    `maxi_code`[^1]     |   `retail_codes`[^5]    |
|           `pzn`            |        `pdf417`        | `industrial_codes`[^6]  |
|         `code_93`          |    `compact_pdf417`    |        `any`[^7]        |
|         `code_128`         |     `micro_pdf417`     |                         |
|         `databar`          |       `qr_code`        |                         |
|       `databar_omni`       |   `qr_code_model_1`    |                         |
|     `databar_stacked`      |   `qr_code_model_2`    |                         |
|   `databar_stacked_omni`   |    `micro_qr_code`     |                         |
|     `databar_expanded`     |      `rm_qr_code`      |                         |
| `databar_expanded_stacked` |                        |                         |
|     `databar_limited`      |                        |                         |
|       `dx_film_edge`       |                        |                         |
|          `ean_8`           |                        |                         |
|          `ean_13`          |                        |                         |
|         `ean_upc`          |                        |                         |
|           `isbn`           |                        |                         |
|           `itf`            |                        |                         |
|          `itf_14`          |                        |                         |
|          `upc_a`           |                        |                         |
|          `upc_e`           |                        |                         |
|         `telepen`          |                        |                         |
|      `telepen_alpha`       |                        |                         |
|     `telepen_numeric`      |                        |                         |

[^1]: Detection support for `MaxiCode` requires a pure monochrome image that contains an unrotated and unskewed symbol, along with a sufficient white border surrounding it.

[^2]: `linear_codes` is a shorthand for all linear barcode formats.

[^3]: `matrix_codes` is a shorthand for all matrix barcode formats.

[^4]: `gs1_codes` is a shorthand for all GS1 barcode formats.

[^5]: `retail_codes` is a shorthand for all retail barcode formats.

[^6]: `industrial_codes` is a shorthand for all industrial barcode formats.

[^7]: `any` is a shorthand for all barcode formats. Note that you don't need to specify `any` in the `formats` option, as not providing the option also indicates detecting all barcode formats.

</div>

## Install

To install, run the following command:

```bash
npm i barcode-detector
```

## Usage

### Ponyfill

```ts
import { BarcodeDetector } from "barcode-detector/ponyfill";
```

To avoid potential namespace collisions, you can also rename the export:

```ts
import { BarcodeDetector as BarcodeDetectorPonyfill } from "barcode-detector/ponyfill";
```

A ponyfill is a module required to be explicitly imported without introducing side effects. Use this subpath if you want to avoid polluting the global object with the `BarcodeDetector` class, or if you intend to use the implementation provided by this package instead of the native one.

### Polyfill

```ts
import "barcode-detector/polyfill";
```

This subpath is used to polyfill the native `BarcodeDetector` class. It will automatically register the `BarcodeDetector` class in the global object **_if it's not already present_**.

> [!IMPORTANT]
>
> The polyfill will opt in only if no `BarcodeDetector` is present in `globalThis`. It basically works like this:
>
> ```ts
> import { BarcodeDetector } from "barcode-detector/ponyfill";
> globalThis.BarcodeDetector ??= BarcodeDetector;
> ```
>
> Note that it **_doesn't_** check if the implementation is provided natively or by another polyfill. It also **_doesn't_** try to augment the existing implementation with all the barcode formats supported by this package. If you want all the features provided by this package, but you already have a native or another polyfilled `BarcodeDetector`, you should use the [ponyfill](#ponyfill) approach. You can register it to the `globalThis` object manually if you want to.

### Ponyfill + Polyfill

```ts
import { BarcodeDetector } from "barcode-detector";
```

This approach combines the [ponyfill](#ponyfill) and [polyfill](#polyfill) approaches.

> [!NOTE]
>
> The `ponyfill` subpath was named `pure` and the `polyfill` subpath was named `side-effects` in early versions. They are no longer recommended for use and are considered deprecated. Please use the new subpaths as described above.

### `<script type="module">`

For [modern browsers that support ES modules](https://caniuse.com/es6-module), this package can be imported via the `<script type="module">` tags:

1. Include the polyfill:

```html
   
   <script
     type="module"
     src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/polyfill.min.js"
   ></script>

<script type="module">
     const barcodeDetector = new BarcodeDetector();
   </script>
   ```

2. Script scoped access:

```html
   <script type="module">
     import { BarcodeDetector } from "https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/ponyfill.min.js";
     const barcodeDetector = new BarcodeDetector();
   </script>
   ```

3. With import maps:

```html
   
   <script type="importmap">
     {
       "imports": {
         "barcode-detector/ponyfill": "https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/es/ponyfill.min.js"
       }
     }
   </script>

<script type="module">
     import { BarcodeDetector } from "barcode-detector/ponyfill";
     const barcodeDetector = new BarcodeDetector();
   </script>
   ```

### IIFE

For legacy browsers or userscripts that lack support for `<script type="module">` tags, IIFE is the preferred choice. Upon executing the IIFE script, a variable named `BarcodeDetectionAPI` will be registered in the global `window` by `var` declaration.

```html

<script src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/iife/ponyfill.min.js"></script>

<script src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/iife/polyfill.min.js"></script>

<script src="https://fastly.jsdelivr.net/npm/barcode-detector@3/dist/iife/index.min.js"></script>
```

## `prepareZXingModule`

The core barcode reading functionality of this package is powered by [`zxing-wasm`](https://github.com/Sec-ant/zxing-wasm). Therefore, a `.wasm` binary file is fetched at runtime. By default, the `.wasm` serving path is initialized with a jsDelivr CDN URL. However, there're cases where this is not desired, such as the allowed serving path is white-listed by the Content Security Policy (CSP), or offline usage is required.

To customize the `.wasm` serving path, this package reexports `prepareZXingModule` along with `ZXING_WASM_VERSION`, `ZXING_WASM_SHA256` and `ZXING_CPP_COMMIT` from `zxing-wasm`. For more details on how to use them, please check [Configuring `.wasm` Serving](https://github.com/Sec-ant/zxing-wasm?tab=readme-ov-file#configuring-wasm-serving) and [Controlling `.wasm` Instantiation Timing and Caching](https://github.com/Sec-ant/zxing-wasm?tab=readme-ov-file#controlling-wasm-instantiation-timing-and-caching) sections in the `zxing-wasm` repository.

An example usage to override the `.wasm` serving path with an `unpkg.com` CDN url is as follows:

```ts
import {
  BarcodeDetector,
  ZXING_WASM_VERSION,
  prepareZXingModule,
} from "barcode-detector/ponyfill";

// Override the locateFile function
prepareZXingModule({
  overrides: {
    locateFile: (path, prefix) => {
      if (path.endsWith(".wasm")) {
        return `https://unpkg.com/zxing-wasm@${ZXING_WASM_VERSION}/dist/reader/${path}`;
      }
      return prefix + path;
    },
  },
});

// Now you can create a BarcodeDetector instance
const barcodeDetector = new BarcodeDetector({
  formats: ["qr_code"],
});
```

> [!Note]
> The `setZXingModuleOverrides` method is deprecated in favor of `prepareZXingModule`.

## API

Please check the [spec](https://wicg.github.io/shape-detection-api/#barcode-detection-api), [MDN doc](https://developer.mozilla.org/docs/Web/API/Barcode_Detection_API) and [Chromium implementation](https://github.com/chromium/chromium/tree/main/third_party/blink/renderer/modules/shapedetection) for more information.

An example usage is as follows:

```ts
import { BarcodeDetector } from "barcode-detector/ponyfill";

// check supported formats
const supportedFormats = await BarcodeDetector.getSupportedFormats();

const barcodeDetector: BarcodeDetector = new BarcodeDetector({
  // make sure the formats are supported
  formats: ["qr_code"],
});

const imageFile = await fetch(
  "https://api.qrserver.com/v1/create-qr-code/?size=150x150&data=Hello%20world!",
).then((resp) => resp.blob());

barcodeDetector.detect(imageFile).then(console.log);
```

## License

The source code in this repository is licensed under the [MIT license](./LICENSE).