https://github.com/yugasun/qrcode-decoder

🤘Tool for decoding qrcode by image,video or camera.
https://github.com/yugasun/qrcode-decoder

camera decoder image qrcode qrcode-decoder qrcode-reader qrcode-scanner video

Last synced: 6 days ago
JSON representation

🤘Tool for decoding qrcode by image,video or camera.

• Host: GitHub
• URL: https://github.com/yugasun/qrcode-decoder
• Owner: yugasun
• License: mit
• Created: 2018-11-20T08:42:05.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T06:12:40.000Z (7 months ago)
• Last Synced: 2025-01-26T23:23:18.041Z (13 days ago)
• Topics: camera, decoder, image, qrcode, qrcode-decoder, qrcode-reader, qrcode-scanner, video
• Language: TypeScript
• Homepage: https://yugasun.github.io/qrcode-decoder/
• Size: 1.64 MB
• Stars: 101
• Watchers: 2
• Forks: 34
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [qrcode-decoder](https://github.com/yugasun/qrcode-decoder)

[![npm](https://img.shields.io/npm/v/qrcode-decoder)](http://www.npmtrends.com/qrcode-decoder)

[![NPM downloads](http://img.shields.io/npm/dm/qrcode-decoder.svg?style=flat-square)](http://www.npmtrends.com/qrcode-decoder)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yugasun/qrcode-decoder/blob/master/LICENSE)

[简体中文](./README.zh-CN.md) | English

A tool for decoding qrcode.

## Directory

```

.

├── demo            code demo

├── dist            build output

├── doc             docs

├── src             source code

├── test            unit test

├── CHANGELOG.md    change log

└── TODO.md         todo list

```

## Guide

Use `pnpm` to install.

```bash

$ pnpm install --save qrcode-decoder

```

Using in webpack:

```js

import QrcodeDecoder from 'qrcode-decoder';

```

Using in browser:

```html

```

## Demo

### QrcodeDecoder()

User `new` to create a decoder object.

```javascript

var qr = new QrcodeDecoder();

```

#### decodeFromImage(img, options)

Decodes an image from url or an `` element with a `src` attribute set.

```javascript

qr.decodeFromImage(img).then((res) => {

  console.log(res);

});

```

[Demo](./demo/image.html)

#### decodeFromVideo(videoElem, options)

Decodes directly from a video with a well specified `src` attribute

```javascript

qr.decodeFromVideo(videoElement).then((res) => {

  console.log(res);

});

```

[Demo](./demo/video.html)

#### decodeFromCamera(videoElem, options)

Decodes from a videoElement.

```javascript

qr.decodeFromCamera(videoElem).then((res) => {

  console.log(res);

});

```

[Demo](./demo/camera.html)

#### stop()

Stops the current `qr` from searching for a QRCode.

## Develop

Install dependencies:

```bash

$ pnpm install

```

Build code:

```bash

$ pnpm run build

```

Run unit test:

```bash

$ pnpm test

```

Modify version in `package.json`, run `release` script:

```bash

$ pnpm run release

```

Publish

```bash

$ pnpm publish

```

## License

[MIT](./LICENSE)