README.zh-CN.md

qrcode-decoder

简体中文 | English

二维码解析工具。

目录介绍

.
├── demo 使用demo
├── dist 编译产出代码
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能

使用者指南

通过 pnpm 下载安装代码

$ pnpm install --save qrcode-decoder

如果你是 webpack 等环境

import QrcodeDecoder from 'qrcode-decoder';

如果你是浏览器环境

<script src="https://unpkg.com/qrcode-decoder@0.3.1/dist/index.min.js"></script>

示例

QrcodeDecoder()

通过 new 关键字生成处理对象。

var qr = new QrcodeDecoder();

decodeFromImage(img, options)

解析页面中的图片二维码。

qr.decodeFromImage(img).then((res) => {
  console.log(res);
});

Demo

decodeFromVideo(videoElem, options)

解析页面中的视频中的二维码。

qr.decodeFromVideo(videoElement).then((res) => {
  console.log(res);
});

Demo

decodeFromCamera(videoElem, options)

通过获取摄像头视频来扫描解析二维码。

qr.decodeFromCamera(videoElem).then((res) => {
  console.log(res);
});

Demo

stop()

停止当前视频捕获。

开发

首次运行需要先安装依赖

$ pnpm install

一键打包生成生产代码

$ pnpm run build

运行单元测试，浏览器环境需要手动测试，位于test/browser

$ pnpm test

修改 package.json 中的版本号，修改 README.md 中的版本号，修改 CHANGELOG.md，然后发布新版

$ pnpm run release

将新版本发布到 pnpm

$ pnpm publish

License

MIT