brave/qr-image

Name: qr-image

Owner: Brave Software

Description: Yet another QR code generator

Forked from: alexeyten/qr-image

Created: 2016-12-16 17:34:10.0

Updated: 2016-12-16 17:34:11.0

Pushed: 2016-12-16 17:42:40.0

Homepage: null

Size: 75

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

qr-image

This is yet another QR Code generator.

Overview

• No dependecies;
• generate image in png, svg, eps and pdf formats;
• numeric and alphanumeric modes;
• support UTF-8.

Releases

Installing

install qr-image

Usage

Example:

qr = require('qr-image');

qr_svg = qr.image('I love QR!', { type: 'svg' });
vg.pipe(require('fs').createWriteStream('i_love_qr.svg'));

svg_string = qr.imageSync('I love QR!', { type: 'svg' });

More examples

qr = require('qr-image')

Methods

• qr.image(text, [ec_level | options]) ? Readable stream with image data;
• qr.imageSync(text, [ec_level | options]) ? string with image data. (Buffer for png);
• qr.svgObject(text, [ec_level | options]) ? object with SVG path and size;
• qr.matrix(text, [ec_level]) ? 2D array.

Options

• text ? text to encode;
• ec_level ? error correction level. One of L, M, Q, H. Default M.
• options ? image options object:
  • ec_level ? default M.
  • type ? image type. Possible values png (default), svg, pdf and eps.
  • size (png and svg only) ? size of one module in pixels. Default 5 for png and undefined for svg.
  • margin ? white space around QR image in modules. Default 4 for png and 1 for others.
  • customize (only png) ? function to customize qr bitmap before encoding to PNG.
  • parse_url (experimental, default false) ? try to optimize QR-code for URLs.

Changes

• Implement imageSync for png.

TODO

• Tests;
• mixing modes;
• Kanji (???).