Package Exports
- qr-image
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (qr-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
qr-image
This is yet another QR Code generator.
Overview
- No dependecies;
- generate image in
png
,svg
,eps
andpdf
formats; - numeric and alphanumeric modes;
- support UTF-8.
Usage
Example:
var qr = require('qr-image');
var qr_svg = qr.image('I love QR!', { type: 'svg' });
qr_svg.pipe(require('fs').createWriteStream('i_love_qr.svg'));
qr = require('qr-image')
qr.image(text, [ec_level | options])
— returns Readable stream with image data.
qr.matrix(text, [ec_level])
— returns 2D array.
text
— text to encode;ec_level
— error correction level. One ofL
,M
,Q
,H
. DefaultM
.options
— image options object:ec_level
— defaultM
.type
— image type. Possible valuespng
(default),svg
(svgpath
),pdf
andeps
.size
(only png) — size of one module in pixels. Default5
.margin
(only png) — white space around QR image in modules. Default4
.customize
(only png) — function to customize qr bitmap before encoding to PNG.
svgpath
is not really an image, but content of d
attribute of corresponding SVG image.
TODO
- Tests;
- mixing modes;
- Kanji (???).