node-qrcode

2025年10月17日 04:30:19
10754
Nodejs 二维码 qrcode
node-qrcode soldair/node-qrcode

qr code generator

项目大小 1.17 KB
涉及语言 JavaScript 100.00%
许可协议 LICENSE
仓库同步说明
  • • 同步需要仓库写入权限以创建目标仓库
  • • 使用平台账号授权登录后将同步到您平台下的个人仓库

node-qrcode

QR code/2d barcode generator.

Travis
npm
npm
npm

Highlights

  • Works on server and client (and react native with svg)
  • CLI utility
  • Save QR code as image
  • Support for Numeric, Alphanumeric, Kanji and Byte mode
  • Support for mixed modes
  • Support for chinese, cyrillic, greek and japanese characters
  • Support for multibyte characters (like emojis :smile:)
  • Auto generates optimized segments for best data compression and smallest QR Code size
  • App agnostic readability, QR Codes by definition are app agnostic

Installation

Inside your project folder do:

1
npm install --save qrcode

or, install it globally to use qrcode from the command line to save qrcode images or generate ones you can view in your terminal.

1
npm install -g qrcode

Usage

CLI

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Usage: qrcode [options] 
 
QR Code options:
  -v, --qversion  QR Code symbol version (1 - 40)                       [number]
  -e, --error     Error correction level           [choices: "L", "M", "Q", "H"]
  -m, --mask      Mask pattern (0 - 7)                                  [number]
 
Renderer options:
  -t, --type        Output type                  [choices: "png", "svg", "utf8"]
  -w, --width       Image width (px)                                    [number]
  -s, --scale       Scale factor                                        [number]
  -q, --qzone       Quiet zone size                                     [number]
  -l, --lightcolor  Light RGBA hex color
  -d, --darkcolor   Dark RGBA hex color
  --small  Output smaller QR code to terminal                          [boolean]
 
Options:
  -o, --output  Output file
  -h, --help    Show help                                              [boolean]
  --version     Show version number                                    [boolean]
 
Examples:
  qrcode "some text"                    Draw in terminal window
  qrcode -o out.png "some text"         Save as png image
  qrcode -d F00 -o out.png "some text"  Use red as foreground color

If not specified, output type is guessed from file extension.

Recognized extensions are png, svg and txt.

Browser

node-qrcode can be used in browser through module bundlers like Browserify and Webpack or by including the precompiled bundle present in build/ folder.

Module bundlers

1
2
3
4
5
6
<html>
  <body>
    <canvas id="canvas">canvas>
    <script src="bundle.js">script>
  body>
html>
1
2
3
4
5
6
7
8
// index.js -> bundle.js
var QRCode = require('qrcode')
var canvas = document.getElementById('canvas')
 
QRCode.toCanvas(canvas, 'sample text', function (error) {
  if (error) console.error(error)
  console.log('success!');
})

Precompiled bundle

1
2
3
4
5
6
7
8
9
<canvas id="canvas">canvas>
 
<script src="/build/qrcode.js">script>
<script>
  QRCode.toCanvas(document.getElementById('canvas'), 'sample text', function (error) {
    if (error) console.error(error)
    console.log('success!');
  })
script>

If you install through npm, precompiled files will be available in node_modules/qrcode/build/ folder.

The precompiled bundle have support for Internet Explorer 10+, Safari 5.1+, and all evergreen browsers.

NodeJS

Require the module qrcode

1
2
3
4
5
var QRCode = require('qrcode')
 
QRCode.toDataURL('I am a pony!', function (err, url) {
  console.log(url)
})

render a qrcode for the terminal

1
2
3
4
5
var QRCode = require('qrcode')
 
QRCode.toString('I am a pony!',{type:'terminal'}, function (err, url) {
  console.log(url)
})

ES6/ES7

Promises and Async/Await can be used in place of callback function.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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)
  }
}

Error correction level

Error correction capability allows to successfully scan a QR Code even if the symbol is dirty or damaged.
Four levels are available to choose according to the operating environment.

Higher levels offer a better error resistance but reduce the symbol’s capacity.

If the chances that the QR Code symbol may be corrupted are low (for example if it is showed through a monitor)
is possible to safely use a low error level such as Low or Medium.

Possible levels are shown below:

Level Error resistance
L (Low) ~7%
M (Medium) ~15%
Q (Quartile) ~25%
H (High) ~30%

The percentage indicates the maximum amount of damaged surface after which the symbol becomes unreadable.

Error level can be set through options.errorCorrectionLevel property.

If not specified, the default value is M.

1
2
3
QRCode.toDataURL('some text', { errorCorrectionLevel: 'H' }, function (err, url) {
  console.log(url)
})

QR Code capacity

Capacity depends on symbol version and error correction level. Also encoding modes may influence the amount of storable data.

The QR Code versions range from version 1 to version 40.

Each version has a different number of modules (black and white dots), which define the symbol’s size.
For version 1 they are 21x21, for version 2 25x25 e so on.
Higher is the version, more are the storable data, and of course bigger will be the QR Code symbol.

The table below shows the maximum number of storable characters in each encoding mode and for each error correction level.

Mode L M Q H
Numeric 7089 5596 3993 3057
Alphanumeric 4296 3391 2420 1852
Byte 2953 2331 1663 1273
Kanji 1817 1435 1024 784

Note: Maximum characters number can be different when using Mixed modes.

QR Code version can be set through options.version property.

If no version is specified, the more suitable value will be used. Unless a specific version is required, this option is not needed.

1
2
3
QRCode.toDataURL('some text', { version: 2 }, function (err, url) {
  console.log(url)
})

Encoding modes

Modes can be used to encode a string in a more efficient way.

A mode may be more suitable than others depending on the string content.
A list of supported modes are shown in the table below:

Mode Characters Compression
Numeric 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 3 characters are represented by 10 bits
Alphanumeric 0–9, A–Z (upper-case only), space, $, %, *, +, -, ., /, : 2 characters are represented by 11 bits
Kanji Characters from the Shift JIS system based on JIS X 0208 2 kanji are represented by 13 bits
Byte Characters from the ISO/IEC 8859-1 character set Each characters are represented by 8 bits

Choose the right mode may be tricky if the input text is unknown.

In these cases Byte mode is the best choice since all characters can be encoded with it. (See Multibyte characters)

However, if the QR Code reader supports mixed modes, using Auto mode may produce better results.

Mixed modes

Mixed modes are also possible. A QR code can be generated from a series of segments having different encoding modes to optimize the data compression.

However, switching from a mode to another has a cost which may lead to a worst result if it’s not taken into account.
See Manual mode for an example of how to specify segments with different encoding modes.

Auto mode

By default, automatic mode selection is used.

The input string is automatically splitted in various segments optimized to produce the shortest possible bitstream using mixed modes.

This is the preferred way to generate the QR Code.

For example, the string ABCDE12345678?A1A will be splitted in 3 segments with the following modes:

Segment Mode
ABCDE Alphanumeric
12345678 Numeric
?A1A Byte

Any other combinations of segments and modes will result in a longer bitstream.

If you need to keep the QR Code size small, this mode will produce the best results.

Manual mode

If auto mode doesn’t work for you or you have specific needs, is also possible to manually specify each segment with the relative mode.
In this way no segment optimizations will be applied under the hood.

Segments list can be passed as an array of object:

1
2
3
4
5
6
7
8
9
10
var QRCode = require('qrcode')
 
var segs = [
  { data: 'ABCDEFG', mode: 'alphanumeric' },
  { data: '0123456', mode: 'numeric' }
]
 
QRCode.toDataURL(segs, function (err, url) {
  console.log(url)
})

Kanji mode

With kanji mode is possible to encode characters from the Shift JIS system in an optimized way.

Unfortunately, there isn’t a way to calculate a Shifted JIS values from, for example, a character encoded in UTF-8, for this reason a conversion table from the input characters to the SJIS values is needed.

This table is not included by default in the bundle to keep the size as small as possible.

If your application requires kanji support, you will need to pass a function that will take care of converting the input characters to appropriate values.

An helper method is provided by the lib through an optional file that you can include as shown in the example below.

Note: Support for Kanji mode is only needed if you want to benefit of the data compression, otherwise is still possible to encode kanji using Byte mode (See Multibyte characters).

1
2
3
4
5
6
var QRCode = require('qrcode')
var toSJIS = require('qrcode/helper/to-sjis')
 
QRCode.toDataURL(kanjiString, { toSJISFunc: toSJIS }, function (err, url) {
  console.log(url)
})

With precompiled bundle:

1
2
3
4
5
6
7
8
9
10
11
<canvas id="canvas">canvas>
 
<script src="/build/qrcode.min.js">script>
<script src="/build/qrcode.tosjis.min.js">script>
<script>
  QRCode.toCanvas(document.getElementById('canvas'),
    'sample text', { toSJISFunc: QRCode.toSJIS }, function (error) {
    if (error) console.error(error)
    console.log('success!')
  })
script>

Binary data

QR Codes can hold arbitrary byte-based binary data. If you attempt to create a binary QR Code by first converting the data to a JavaScript string, it will fail to encode propery because string encoding adds additional bytes. Instead, you must pass a Uint8ClampedArray or compatible array, or a Node Buffer, as follows:

1
2
3
4
5
6
7
8
9
// 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...
)
1
2
3
4
5
6
7
8
9
// Uint8ClampedArray example
const QRCode = require('qrcode')
 
QRCode.toFile(
  'foo.png',
  [{ data: new Uint8ClampedArray([253,254,255]), mode: 'byte' }],
  ...options...,
  ...callback...
)
1
2
3
4
5
6
7
8
9
10
// 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...
)

TypeScript users: if you are using @types/qrcode, you will need to add a // @ts-ignore above the data segment because it expects data: string.

Multibyte characters

Support for multibyte characters isn’t present in the initial QR Code standard, but is possible to encode UTF-8 characters in Byte mode.

QR Codes provide a way to specify a different type of character set through ECI (Extended Channel Interpretation), but it’s not fully implemented in this lib yet.

Most QR Code readers, however, are able to recognize multibyte characters even without ECI.

Note that a single Kanji/Kana or Emoji can take up to 4 bytes.

API

Browser:

Server:

Browser API

create(text, [options])

Creates QR Code symbol and returns a qrcode object.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options

See QR Code options.

returns

Type: Object

1
2
3
4
5
6
7
8
// QRCode object
{
  modules,              // Bitmatrix class with modules data
  version,              // Calculated QR Code version
  errorCorrectionLevel, // Error Correction Level
  maskPattern,          // Calculated Mask pattern
  segments              // Generated segments
}

toCanvas(canvasElement, text, [options], [cb(error)])

toCanvas(text, [options], [cb(error, canvas)])

Draws qr code symbol to canvas.

If canvasElement is omitted a new canvas is returned.

canvasElement

Type: DOMElement

Canvas where to draw QR Code.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options

See Options.

cb

Type: Function

Callback function called on finish.

Example
1
2
3
4
5
6
QRCode.toCanvas('text', { errorCorrectionLevel: 'H' }, function (err, canvas) {
  if (err) throw err
 
  var container = document.getElementById('container')
  container.appendChild(canvas)
})

toDataURL(text, [options], [cb(error, url)])

toDataURL(canvasElement, text, [options], [cb(error, url)])

Returns a Data URI containing a representation of the QR Code image.

If provided, canvasElement will be used as canvas to generate the data URI.

canvasElement

Type: DOMElement

Canvas where to draw QR Code.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options
  • type

    Type: String

    Default: image/png

    Data URI format.

    Possible values are: image/png, image/jpeg, image/webp.

  • rendererOpts.quality

    Type: Number

    Default: 0.92

    A Number between 0 and 1 indicating image quality if the requested type is image/jpeg or image/webp.

See Options for other settings.

cb

Type: Function

Callback function called on finish.

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var 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 err
 
  var img = document.getElementById('image')
  img.src = url
})

toString(text, [options], [cb(error, string)])

Returns a string representation of the QR Code.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options
  • type

    Type: String

    Default: utf8

    Output format.

    Possible values are: terminal,utf8, and svg.

See Options for other settings.

cb

Type: Function

Callback function called on finish.

Example
1
2
3
4
QRCode.toString('http://www.google.com', function (err, string) {
  if (err) throw err
  console.log(string)
})

Server API

create(text, [options])

See create.


toCanvas(canvas, text, [options], [cb(error)])

Draws qr code symbol to node canvas.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options

See Options.

cb

Type: Function

Callback function called on finish.


toDataURL(text, [options], [cb(error, url)])

Returns a Data URI containing a representation of the QR Code image.

Only works with image/png type for now.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options

See Options for other settings.

cb

Type: Function

Callback function called on finish.


toString(text, [options], [cb(error, string)])

Returns a string representation of the QR Code.

If choosen output format is svg it will returns a string containing xml code.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options
  • type

    Type: String

    Default: utf8

    Output format.

    Possible values are: utf8, svg, terminal.

See Options for other settings.

cb

Type: Function

Callback function called on finish.

Example
1
2
3
4
QRCode.toString('http://www.google.com', function (err, string) {
  if (err) throw err
  console.log(string)
})

toFile(path, text, [options], [cb(error)])

Saves QR Code to image file.

If options.type is not specified, the format will be guessed from file extension.

Recognized extensions are png, svg, txt.

path

Type: String

Path where to save the file.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options
  • type

    Type: String

    Default: png

    Output format.

    Possible values are: png, svg, utf8.

  • rendererOpts.deflateLevel (png only)

    Type: Number

    Default: 9

    Compression level for deflate.

  • rendererOpts.deflateStrategy (png only)

    Type: Number

    Default: 3

    Compression strategy for deflate.

See Options for other settings.

cb

Type: Function

Callback function called on finish.

Example
1
2
3
4
5
6
7
8
9
QRCode.toFile('path/to/filename.png', 'Some text', {
  color: {
    dark: '#00F',  // Blue dots
    light: '#0000' // Transparent background
  }
}, function (err) {
  if (err) throw err
  console.log('done')
})

toFileStream(stream, text, [options])

Writes QR Code image to stream. Only works with png format for now.

stream

Type: stream.Writable

Node stream.

text

Type: String|Array

Text to encode or a list of objects describing segments.

options

See Options.


Options

QR Code options

version

Type: Number

QR Code version. If not specified the more suitable value will be calculated.

errorCorrectionLevel

Type: String

Default: M

Error correction level.

Possible values are low, medium, quartile, high or L, M, Q, H.

maskPattern

Type: Number

Mask pattern used to mask the symbol.

Possible values are 0, 1, 2, 3, 4, 5, 6, 7.

If not specified the more suitable value will be calculated.

toSJISFunc

Type: Function

Helper function used internally to convert a kanji to its Shift JIS value.

Provide this function if you need support for Kanji mode.

Renderers options

margin

Type: Number

Default: 4

Define how much wide the quiet zone should be.

scale

Type: Number

Default: 4

Scale factor. A value of 1 means 1px per modules (black dots).

small

Type: Boolean

Default: false

Relevant only for terminal renderer. Outputs smaller QR code.

width

Type: Number

Forces a specific width for the output image.

If width is too small to contain the qr symbol, this option will be ignored.

Takes precedence over scale.

color.dark

Type: String

Default: #000000ff

Color of dark module. Value must be in hex format (RGBA).

Note: dark color should always be darker than color.light.

color.light

Type: String

Default: #ffffffff

Color of light module. Value must be in hex format (RGBA).


GS1 QR Codes

There was a real good discussion here about them. but in short any qrcode generator will make gs1 compatible qrcodes, but what defines a gs1 qrcode is a header with metadata that describes your gs1 information.

https://github.com/soldair/node-qrcode/issues/45

Credits

This lib is based on “QRCode for JavaScript” which Kazuhiko Arase thankfully MIT licensed.

License

MIT

The word “QR Code” is registered trademark of:

DENSO WAVE INCORPORATED


                

      
                

                      

                

              

             

      
            

                
                

                    免责声明 © 2026 - 虚宝阁
                

                
                

                    

                        本站部分源码来源于网络，版权归属原开发者，用户仅获得使用权。依据《计算机软件保护条例》第十六条，禁止：
                    

                    
    
                        
  • 逆向工程破解技术保护措施
    • 
                        
  • 未经许可的分发行为
    • 
                        
  • 去除源码中的原始版权标识
    • 
                    

                    
※ 本站源码仅用于学习和研究，禁止用于商业用途。如有侵权, 请及时联系我们进行处理。

                

            
                
                

                    

                        侵权举报请提供：
                        侵权页面URL | 
                        权属证明模板
                    

                    响应时效：收到完整材料后48小时内处理
                

            

            

              

                  
                  

                      
                  

                  
                  
                  

                      
                  

              
                  
                  

                      
                  

                  
                  
                  

                      
                  

              
              
                  
                  
              
      

      
          

      
            
          

    
相关推荐

    

        

            
            
                Claudable：基于 Next.js 框架的网站生成器
                
                

                    
Claudable：基于 Next.js 框架的网站生成器

                    
把你用自然语言描述的应用想法，直接变成可以运行的网站代码。Claudable 背后依赖强大的 AI 编程助手，主要是 Claude Code，也支持 Cursor CLI 来理解你的需求并生成代码。你不需要懂复杂的 API 设置、数据库配置或者部署流程：用简单的语言告诉 Claudable 你想要什么应用。

                    

                        2525
                        2025-09-15
                    

                

            
            
                n8n： AI自动化工作流工具
                
                

                    
n8n： AI自动化工作流工具

                    
基于节点的自动化工作流工具，能帮助用户轻松创建和管理复杂的自动化流程，无需编写大量代码。并且内置了AI能力，支持 400+ 应用和服务！

                    

                        146989
                        2025-09-26
                    

                

            
            
                ant-design-vue-pro
                
                

                    
ant-design-vue-pro

                    
👨🏻‍💻👩🏻‍💻 Use Ant Design Vue like a Pro!   (vue2)

                    

                        10932
                        2025-09-20
                    

                

            
            
                hnswlib-node
                
                

                    
hnswlib-node

                    
hnswlib - node为Hnswlib提供Node.js绑定，实现基于分层可导航小世界图的近似最近邻搜索。详情参考搜索索引和搜索近邻的代码示例。

                    

                        119
                        2025-08-28
                    

                

            
            
                adm-zip： nodejs 中 zip文件压缩神器
                
                

                    
adm-zip： nodejs 中 zip文件压缩神器

                    
ADM - ZIP是用于NodeJS的纯JavaScript实现的ZIP数据压缩库。可通过npm安装，无其他NodeJS依赖。能解压、压缩文件，更新ZIP内容。更多详情查看wiki。

                    

                        2138
                        2025-08-28
                    

                

            
            
                fastapi： Python web api 框架
                
                

                    
fastapi： Python web api 框架

                    
一个基于 Python 3.6+ 版本的异步 WEB 应用框架，使用 Python 类型注解构建 web API 。主要特点有:

高性能：与 Node JS 和 Go 相当。
编码快：将开发功能的速度提高 2~3 倍。
Bug少：减少大约 40% 的由开发人员导致的错误。
直观：强大的编辑器支持，可智能感知和补全代码。
简单：易于学习和使用，减少文档阅读时间。
简短：尽量减少代码重复。
健壮：获得可用于生产的代码，具有自动交互文档。
基于标准：基于 OpenAPI 和 JSON Schema 。

                    

                        90539
                        2025-09-16
                    

                

            
            
                markdown-it
                
                

                    
markdown-it

                    
markdown-it是一款快速且易扩展的Markdown解析器，遵循CommonMark规范并添加语法扩展。它配置灵活、速度快且安全，还有丰富的社区插件。

                    

                        20415
                        2025-09-09
                    

                

            
            
                DeepFaceLab
                
                

                    
DeepFaceLab

                    
换脸圈的“老大哥”，开源界扛把子，功能强到离谱。不管是图片换脸、长视频换脸，还是修复模糊人脸，它都能搞定。网上很多高质量换脸视频都出自它手，但毕竟是专业级选手，上手难度稍高，得花点时间研究流程，学会了就能玩出花。

                    

                        18651
                        2025-09-14
                    

                

            
        

    




        

      
        
        

          
          
      
          

              

                  

                      

                          
                      

                      

                          
仓库下载

                      

                  

              

              

                  
                      
                          gitee
                      
              

              

                  

                  

                  
                  

                      
                      

                          

                               GitHub 下载代理
                          

                          
                      

              
                      
                      

                          
                          

                              
                              
                              
                              

                                  
                                  
                                  
                                  

                                      

                                          

                                              正在下载文件...
                                          

                                          

                                              

                                              

                                          

                                          

                                              
                                          

                                      

                                  

                              

                          

              
                          
              
                          
                          

                              
文件信息

                              

                                  

                                      文件名
                                      
                                  

                                  

                                      文件大小
                                      
                                  

                                  

                                      文件类型
                                      
                                  

                                  

                                      代理耗时
                                      
                                  

                              

                          

                      

                  

              

              

      
热 榜

      


          

              
          

          
          
            

              cover
            

            

              
scira： AI 驱动搜索引擎

              

                51676
              

            

          
          
            

              cover
            

            

              
image-compressor： 前端图片压缩库

              

                20370
              

            

          
          
            

              cover
            

            

              
squish： 基于浏览器的图像压缩工具

              

                9751
              

            

          
          
            

              cover
            

            

              
AirBattery： 隔空查看苹果设备电量的 Mac 工具

              

                36027
              

            

          
          
            

              cover
            

            

              
Seelen-UI： 高度可定制的 Windows 桌面美化工具

              

                16955
              

            

          
          
            

              cover
            

            

              
pyscript： 直接在浏览器中用 Python 创建应用程序

              

                22120
              

            

          
          
            

              cover
            

            

              
pydoll： 无需 WebDriver 的浏览器自动化 Python 库

              

                14723
              

            

          
          
            

              cover
            

            

              
pdfplumber： 轻松提取 PDF 文本和表格的 Python 库

              

                24881
              

            

          
        
      

      

      
      
      

          

              
          

      

    

  

      
      

      
    


      


      

        

          

              
友情链接

              

                  
                    

                      Github-最大的开源仓库
                    

                    

                        
Github

                        
                    

                  
                  
                    

                      Gitee-国内开源仓库, github国内镜像仓库
                    

                    

                        
Gitee

                        
                    

                  
                  
                    

                      Gitcode-与AtomGit深度融合的开源社区
                    

                    

                        
Gitcode