History

Project Nayuki 8329a7108f Slightly simplified the calculation of alignment pattern spacing in a non-obvious way, adapted from David Evans's "Lean QR" project.		3 months ago
..
Readme.markdown	- In the project (top-level) readme file, kept one language's code example and moved all others out to language-specific readme files.	3 years ago
build.sh	Removed the test worker program in every language and the Python batch tester, because this is not core functionality and is hard to explain.	3 years ago
qrcodegen-input-demo.html	Changed the TypeScript input demo to add a download link for bitmap and vector output formats, and stop displaying the SVG XML code.	2 years ago
qrcodegen-input-demo.ts	Changed the TypeScript input demo to add a download link for bitmap and vector output formats, and stop displaying the SVG XML code.	2 years ago
qrcodegen-output-demo.html	Slightly improved the visual appearance of web pages for TypeScript/JavaScript demos, also tweaked a bit of HTML code.	3 years ago
qrcodegen-output-demo.ts	Changed calls of the non-standard method String.substr() to substring().	2 years ago
qrcodegen.ts	Slightly simplified the calculation of alignment pattern spacing in a non-obvious way, adapted from David Evans's "Lean QR" project.	3 months ago

Readme.markdown

QR Code generator library - TypeScript

Introduction

This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.

Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library

Features

Core features:

Significantly shorter code but more documentation comments compared to competing libraries
Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
Output format: Raw modules/pixels of the QR symbol
Detects finder-like penalty patterns more accurately than other implementations
Encodes numeric and special-alphanumeric text in less space than general text
Open-source code under the permissive MIT License

Manual parameters:

User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data
User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one
User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number
User can create a list of data segments manually and add ECI segments

More information about QR Code technology and this library's design can be found on the project home page.

Examples

// Name abbreviated for the sake of these examples here
const QRC = qrcodegen.QrCode;

// Simple operation
const qr0 = QRC.encodeText("Hello, world!", QRC.Ecc.MEDIUM);
const svg = toSvgString(qr0, 4);  // See qrcodegen-input-demo

// Manual operation
const segs = qrcodegen.QrSegment.makeSegments("3141592653589793238462643383");
const qr1 = QRC.encodeSegments(segs, QRC.Ecc.HIGH, 5, 5, 2, false);
for (let y = 0; y < qr1.size; y++) {
    for (let x = 0; x < qr1.size; x++) {
        (... paint qr1.getModule(x, y) ...)
    }
}

More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/typescript-javascript/qrcodegen-output-demo.ts .