qrcode-decoder - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #android #machine-learning #rust #deep-learning #macos #windows #cli #awesome-list #pytorch #security #openai

qrcode-decoder

(★ 104)

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

File Explorer

Download Latest Version (.zip)

- - ci.yml
- ISSUE_TEMPLATE
- index.test.ts
- - duck.jpg
  - qrcode-video.mp4
  - qrcode.png
- - vconsole.min.js
- camera.html
- image.html
- index.html
- video.html
- api.md
- api.zh-CN.md
- bundle.ts
- logger.ts
- tsconfig.json
- index.ts
.babelrc
.editorconfig
.gitignore
.npmignore
.npmrc
.prettierignore
.prettierrc
jest.config.js
LICENSE
package.json
pnpm-lock.yaml
README.md
README.zh-CN.md
TODO.md
tsconfig.json
tslint.json

# Installation Guide

1. Get the code

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

Downloads the entire project code from GitHub to your computer.

cd qrcode-decoder

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.

$ pnpm install --save qrcode-decoder

Downloads and installs the libraries listed in package.json.

$ pnpm install

Downloads and installs the libraries listed in package.json.

$ pnpm run build

Builds optimized production files.

$ pnpm test

Type this command into your terminal and run it.

$ pnpm run release

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)

# [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
<script src="https://unpkg.com/qrcode-decoder@0.3.1/dist/index.min.js"></script>
```

## Demo

### QrcodeDecoder()

User `new` to create a decoder object.

```javascript
var qr = new QrcodeDecoder();
```

#### decodeFromImage(img, options)

Decodes an image from url or an `<img>` 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)