1QR Code generator library - TypeScript 2====================================== 3 4 5Introduction 6------------ 7 8This 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. 9 10Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library 11 12 13Features 14-------- 15 16Core features: 17 18* Significantly shorter code but more documentation comments compared to competing libraries 19* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard 20* Output format: Raw modules/pixels of the QR symbol 21* Detects finder-like penalty patterns more accurately than other implementations 22* Encodes numeric and special-alphanumeric text in less space than general text 23* Open-source code under the permissive MIT License 24 25Manual parameters: 26 27* User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data 28* User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one 29* User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number 30* User can create a list of data segments manually and add ECI segments 31 32More information about QR Code technology and this library's design can be found on the project home page. 33 34 35Examples 36-------- 37 38```typescript 39// Name abbreviated for the sake of these examples here 40const QRC = qrcodegen.QrCode; 41 42// Simple operation 43const qr0 = QRC.encodeText("Hello, world!", QRC.Ecc.MEDIUM); 44const svg = toSvgString(qr0, 4); // See qrcodegen-input-demo 45 46// Manual operation 47const segs = qrcodegen.QrSegment.makeSegments("3141592653589793238462643383"); 48const qr1 = QRC.encodeSegments(segs, QRC.Ecc.HIGH, 5, 5, 2, false); 49for (let y = 0; y < qr1.size; y++) { 50 for (let x = 0; x < qr1.size; x++) { 51 (... paint qr1.getModule(x, y) ...) 52 } 53} 54``` 55 56More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/typescript-javascript/qrcodegen-output-demo.ts . 57