插件:qrcode的使用

2024-06-02 16:36
文章标签 使用 插件 qrcode

本文主要是介绍插件:qrcode的使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

源文档: qrcode文档

安装

npm install --save qrcode

TypeScript用户:如果您使用@types/qrcode,则需要在数据段上方添加//@ts ignore,因为它需要data:string。

用法

用法:qrcode〔options〕<input string>二维码选项:
-v、 --qversion二维码符号版本(1-40)[编号]
-e、 --error纠错级别[选项:“L”、“M”、“Q”、“H”]
-m、 --掩码掩码模式(0-7)[数字]渲染器选项:
-t、 --type输出类型[选项:“png”、“svg”、”utf8“]
-w、 --width图像宽度(px)[数字]
-s、 --比例比例因子[数字]
-q、 --qzone安静区域大小[number]
-l、 --lightcolor Light RGBA十六进制颜色
-d、 --深色深色RGBA十六进制颜色
--small将较小的二维码输出到终端[布尔值]选项:
-o、 --输出输出文件
-h、 --help显示帮助[boolean]
--version显示版本号[布尔值]示例:
qrcode“some text”在终端窗口中绘制
qrcode-o out.png“some text”另存为png图像
qrcode-d F00-o out.png“some text”使用红色作为前景色

如果未指定,则根据文件扩展名推测输出类型。可识别的扩展名有png、svg和txt。

API

浏览器端api

1.create()  创建二维码符号并返回一个二维码对象。

create(text, [options])

text: 要编码的文本或描述分段的对象列表。

options:  

 1.1 returns : object类型

// QRCode object
{modules,              // 具有模块数据的位矩阵类version,              // 二维码版本errorCorrectionLevel, // 纠错级别maskPattern,          // 计算的遮罩图案segments              // 生成的分段
}

2.toCanvas()   在画布上绘制二维码符号。

toCanvas(canvasElement,text,[options],[cb(error)])和 toCanvas(text, [options], [cb(error, canvas)]) ,如果省略了canvasElement,则返回一个新的画布。

2.1canvasElement: 画布绘制二维码绑定的dom元素。

2.2text:   要编码的文本或描述分段的对象列表。

2.3options: 

   2.3.1  cb:绘制完成时调用的回调函数

QRCode.toCanvas('text', { errorCorrectionLevel: 'H' }, function (err, canvas) {if (err) throw errvar container = document.getElementById('container')container.appendChild(canvas)
})

节点qrcode可以通过Browserify和Webpack等模块捆绑器在浏览器中使用,也可以通过将预编译的捆绑包包含在构建/文件夹中来使用。 

<!-- index.html -->
<html><body><canvas id="canvas"></canvas><script src="bundle.js"></script></body>
</html>
// index.js -> bundle.js
const QRCode = require('qrcode')
const canvas = document.getElementById('canvas')QRCode.toCanvas(canvas, 'sample text', function (error) {if (error) console.error(error)console.log('success!');
})

ES6/ES7中使用(Promises和Async/Await可以用来代替回调函数)

import QRCode from 'qrcode'// With promises
QRCode.toDataURL('I am a pony!').then(url => {console.log(url)}).catch(err => {console.error(err)})// With async/await
const generateQR = async text => {try {console.log(await QRCode.toDataURL(text))} catch (err) {console.error(err)}
}

 二进制数据

QR码可以保存基于任意字节的二进制数据。如果您试图通过首先将数据转换为JavaScript字符串来创建二进制QR码,它将无法正确编码,因为字符串编码会添加额外的字节。相反,您必须传递一个Uint8ClampedArray或兼容的数组,或一个Node Buffer,如下所示:

// Regular array example
// WARNING: Element values will be clamped to 0-255 even if your data contains higher values.
const QRCode = require('qrcode')
QRCode.toFile('foo.png',[{ data: [253,254,255], mode: 'byte' }],...options...,...callback...
)
// Uint8ClampedArray example
const QRCode = require('qrcode')QRCode.toFile('foo.png',[{ data: new Uint8ClampedArray([253,254,255]), mode: 'byte' }],...options...,...callback...
)
// Node Buffer example
// WARNING: Element values will be clamped to 0-255 even if your data contains higher values.
const QRCode = require('qrcode')QRCode.toFile('foo.png',[{ data: Buffer.from([253,254,255]), mode: 'byte' }],...options...,...callback...
)

3.toDataURL()   返回包含二维码图像表示形式的数据URI。如果提供,canvasElement将被用作画布来生成数据URI。

toDataURL(文本,[选项],[cb(错误,url)])和  toDataURL(canvasElement,text,[options],[cb(error,url)])。

3.1 canvasElement: 画布绘制二维码绑定的dom元素。

3.2 text:   要编码的文本或描述分段的对象列表。

3.3 options: 

   3.3.1 type 

   类型: String
   可能的值有:images/png、images/jpeg、images/web。

   3.3.2  rendererOpts.quality: 

   类型: Number

   一个介于0和1之间的数字,如果请求的类型是image/jpeg或image/web,则表示图像质量。

   3.3.3  cb  绘制完成时调用的回调函数

const opts = {errorCorrectionLevel: 'H',type: 'image/jpeg',quality: 0.3,margin: 1,color: {dark:"#010599FF",light:"#FFBF60FF"}
}QRCode.toDataURL('text', opts, function (err, url) {if (err) throw errvar img = document.getElementById('image')img.src = url
})

4.toString()

toString(text,[options],[cb(error,string)])返回QR代码的字符串表示形式。

4.1 text:   要编码的文本或描述分段的对象列表。

4.2 options: 

      4.2.1 type

      类型: String

      可能的值有:terminal、utf8和svg。

      4.2.2  cb   绘制完成时调用的回调函数

QRCode.toString('http://www.google.com', function (err, string) {if (err) throw errconsole.log(string)
})

这篇关于插件:qrcode的使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1024503

相关文章

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解

《使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解》本文详细介绍了如何使用Python通过ncmdump工具批量将.ncm音频转换为.mp3的步骤,包括安装、配置ffmpeg环... 目录1. 前言2. 安装 ncmdump3. 实现 .ncm 转 .mp34. 执行过程5. 执行结

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

Java中的抽象类与abstract 关键字使用详解

《Java中的抽象类与abstract关键字使用详解》:本文主要介绍Java中的抽象类与abstract关键字使用详解,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧... 目录一、抽象类的概念二、使用 abstract2.1 修饰类 => 抽象类2.2 修饰方法 => 抽象方法,没有

MyBatis ParameterHandler的具体使用

《MyBatisParameterHandler的具体使用》本文主要介绍了MyBatisParameterHandler的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录一、概述二、源码1 关键属性2.setParameters3.TypeHandler1.TypeHa

Spring 中的切面与事务结合使用完整示例

《Spring中的切面与事务结合使用完整示例》本文给大家介绍Spring中的切面与事务结合使用完整示例,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考... 目录 一、前置知识:Spring AOP 与 事务的关系 事务本质上就是一个“切面”二、核心组件三、完

使用docker搭建嵌入式Linux开发环境

《使用docker搭建嵌入式Linux开发环境》本文主要介绍了使用docker搭建嵌入式Linux开发环境,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录1、前言2、安装docker3、编写容器管理脚本4、创建容器1、前言在日常开发全志、rk等不同

使用Python实现Word文档的自动化对比方案

《使用Python实现Word文档的自动化对比方案》我们经常需要比较两个Word文档的版本差异,无论是合同修订、论文修改还是代码文档更新,人工比对不仅效率低下,还容易遗漏关键改动,下面通过一个实际案例... 目录引言一、使用python-docx库解析文档结构二、使用difflib进行差异比对三、高级对比方

sky-take-out项目中Redis的使用示例详解

《sky-take-out项目中Redis的使用示例详解》SpringCache是Spring的缓存抽象层,通过注解简化缓存管理,支持Redis等提供者,适用于方法结果缓存、更新和删除操作,但无法实现... 目录Spring Cache主要特性核心注解1.@Cacheable2.@CachePut3.@Ca