The qrcode npm package is a library for generating QR codes. It can be used to create QR codes in various formats such as images or canvas for web applications, and it supports a range of customization options.

What are qrcode's main functionalities?

Generating QR Code as Data URL

This feature allows you to generate a QR code as a data URL, which can be used directly in image tags or CSS backgrounds.

const QRCode = require('qrcode');
QRCode.toDataURL('https://www.example.com', function (err, url) {
  console.log(url);
});

Generating QR Code as PNG Image File

This feature allows you to generate a QR code and save it as a PNG image file on the filesystem.

const QRCode = require('qrcode');
QRCode.toFile('path/to/output.png', 'https://www.example.com', function (err) {
  if (err) throw err;
  console.log('QR Code saved as image file!');
});

Generating QR Code as UTF8 String

This feature allows you to generate a QR code as a UTF8 string, which can be printed to the terminal or used in text-based formats.

const QRCode = require('qrcode');
QRCode.toString('https://www.example.com', { type: 'terminal' }, function (err, string) {
  if (err) throw err;
  console.log(string);
});

Other packages similar to qrcode

Readme

Source

This is a node js server side QR code / 2d barcode generator. it is an extension of "QRCode for JavaScript" which Kazuhiko Arase thankfully mit licensed

the qrcode-draw.js can be used directly as a client side lib if its appended too or included with lib/qrcode.js to use this on the server side please require('qrcode'); =)

install:

npm install qrcode

dependencies:

npm install canvas

api: QRCode.draw(text,cb(error,canvas)); returns node canvas object see https://github.com/LearnBoost/node-canvas for all of the cool node things you can do look up the canvas api for the other cool things

QRCode.toDataURL(text,cb(error,dataURL));
	returns mime image/png data url for the 2d barcode 

QRCode.save(path,text,cb(error,written));
	saves png to the path specified returns bytes

examples: ---code--- // simple test var sys = require('sys'); var QRCode = require('qrcode');

QRCode.toDataURL('i am a pony!',function(err,url){
	sys.print(url);
});

--- execute ---
node ./tests/url.js


for server use
	see tests/server.js

for client side use
	open tests/clientside.html in your browser

The word "QR Code" is registered trademark of DENSO WAVE INCORPORATED

Keywords

FAQs

What is qrcode?

Is qrcode well maintained?

Last updated on 27 Dec 2010

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install