{"_id":"binaryify-awesome-qr","_rev":"3292727","name":"binaryify-awesome-qr","description":"An awesome but simple QR code generator written in JavaScript.","dist-tags":{"latest":"2.2.2"},"maintainers":[{"name":"traveller","email":""}],"time":{"modified":"2024-05-30T03:16:44.000Z","created":"2021-05-03T11:40:35.006Z","2.2.2":"2021-10-02T12:49:37.040Z","2.2.1":"2021-10-02T12:35:13.484Z","2.2.0":"2021-10-02T12:17:13.494Z","2.1.10":"2021-05-09T02:47:22.029Z","2.1.9":"2021-05-09T02:28:22.525Z","2.1.8":"2021-05-07T14:15:37.877Z","2.1.7":"2021-05-06T13:21:04.928Z","2.1.6":"2021-05-03T13:38:31.007Z","2.1.5":"2021-05-03T12:59:13.615Z","2.1.4":"2021-05-03T11:40:35.006Z"},"users":{},"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"versions":{"2.2.2":{"name":"binaryify-awesome-qr","version":"2.2.2","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"^2.8.0","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.2.2","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"shasum":"3293eb23899a30da2eac5e232f41196bba2bde97","size":77270,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.2.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.2.2.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.2.2_1633178976874_0.9727362044256593"},"_hasShrinkwrap":false,"publish_time":1633178977040,"_cnpm_publish_time":1633178977040,"_cnpmcore_publish_time":"2021-12-16T15:14:07.844Z"},"2.2.1":{"name":"binaryify-awesome-qr","version":"2.2.1","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"^2.8.0","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.2.1","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"shasum":"69153e262fac95715975c77923d512ee5f23a129","size":77169,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.2.1.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.2.1_1633178113180_0.718461361043031"},"_hasShrinkwrap":false,"publish_time":1633178113484,"_cnpm_publish_time":1633178113484,"_cnpmcore_publish_time":"2021-12-16T15:14:08.155Z"},"2.2.0":{"name":"binaryify-awesome-qr","version":"2.2.0","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"^2.8.0","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.2.0","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"shasum":"b5358ae34fb753ef010866b9c6859b50ff3af6d1","size":76677,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.2.0.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.2.0_1633177033354_0.9761516949819591"},"_hasShrinkwrap":false,"publish_time":1633177033494,"_cnpm_publish_time":1633177033494,"_cnpmcore_publish_time":"2021-12-16T15:14:08.443Z"},"2.1.10":{"name":"binaryify-awesome-qr","version":"2.1.10","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"^2.7.0","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.10","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"c24595dc620d1a93dd6fa8d9028e56303aa407f1","size":16302152,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.10.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.10.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.10_1620528441601_0.700774551973258"},"_hasShrinkwrap":false,"publish_time":1620528442029,"_cnpm_publish_time":1620528442029,"_cnpmcore_publish_time":"2021-12-16T15:14:27.176Z"},"2.1.9":{"name":"binaryify-awesome-qr","version":"2.1.9","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"^2.7.0","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.9","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"e6b9160aac6d64cb74d102c972019ab26c97ab26","size":16302155,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.9.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.9.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.9_1620527302081_0.9141029534324492"},"_hasShrinkwrap":false,"publish_time":1620527302525,"_cnpm_publish_time":1620527302525,"_cnpmcore_publish_time":"2021-12-16T15:14:43.801Z"},"2.1.8":{"name":"binaryify-awesome-qr","version":"2.1.8","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.8","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"e4aec1564bded0749c4edbf3bdcb5816c2c4e9d8","size":16302143,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.8.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.8.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.8_1620396937316_0.807484395190265"},"_hasShrinkwrap":false,"publish_time":1620396937877,"_cnpm_publish_time":1620396937877,"_cnpmcore_publish_time":"2021-12-16T15:14:58.591Z"},"2.1.7":{"name":"binaryify-awesome-qr","version":"2.1.7","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.7","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"dc810794d45f80669431171c04f8faba49377a07","size":16301564,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.7.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.7.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.7_1620307261840_0.19967693650960006"},"_hasShrinkwrap":false,"publish_time":1620307264928,"_cnpm_publish_time":1620307264928,"_cnpmcore_publish_time":"2021-12-16T15:15:11.749Z"},"2.1.6":{"name":"binaryify-awesome-qr","version":"2.1.6","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"git+https://github.com/Automattic/node-canvas.git#6fae569fc5e2ca2d5d81c9d15a0fe49bfb993b51","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.6","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"b2c43d4f3447aa19e4e2d0cab08b62ce2ed1b398","size":16301620,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.6.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.6.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.6_1620049110618_0.5543934712909684"},"_hasShrinkwrap":false,"publish_time":1620049111007,"_cnpm_publish_time":1620049111007,"_cnpmcore_publish_time":"2021-12-16T15:15:24.442Z"},"2.1.5":{"name":"binaryify-awesome-qr","version":"2.1.5","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"git+https://github.com/Automattic/node-canvas.git#6fae569fc5e2ca2d5d81c9d15a0fe49bfb993b51","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.5","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"0678bb5a93c19a341af53aabbc1426f4890ecf36","size":16301584,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.5.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.5.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.5_1620046753271_0.9183575707017297"},"_hasShrinkwrap":false,"publish_time":1620046753615,"_cnpm_publish_time":1620046753615,"_cnpmcore_publish_time":"2021-12-16T15:15:36.167Z"},"2.1.4":{"name":"binaryify-awesome-qr","version":"2.1.4","description":"An awesome but simple QR code generator written in JavaScript.","main":"./lib/index.js","types":"./lib/index.d.ts","scripts":{"test":"mocha","build":"webpack --config webpack.config.js && tsc","prepublishOnly":"webpack --config webpack.config.js && tsc"},"repository":{"type":"git","url":"git+https://github.com/SumiMakito/Awesome-qr.js.git"},"keywords":["qr","qrcode","barcode"],"author":{"name":"Makito","email":"sumimakito@hotmail.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","dependencies":{"buffer":"^6.0.3","canvas":"git+https://github.com/Automattic/node-canvas.git#6fae569fc5e2ca2d5d81c9d15a0fe49bfb993b51","js-binary-schema-parser":"^2.0.0"},"devDependencies":{"@types/node":"^14.0.14","jimp":"^0.16.1","mocha":"^8.3.0","qrcode-reader":"^1.0.4","tmp":"^0.2.1","ts-loader":"^8.0.18","typescript":"^3.9.6","webpack":"^5.27.2","webpack-cli":"^4.5.0"},"gitHead":"e4e70c2ac0f9edcb1dde2c7f50f30ba836e18891","_id":"binaryify-awesome-qr@2.1.4","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"96f6e71345a12d54f276536e0e29a881daa8f3a5","size":16301502,"noattachment":false,"key":"/binaryify-awesome-qr/-/binaryify-awesome-qr-2.1.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/binaryify-awesome-qr/download/binaryify-awesome-qr-2.1.4.tgz"},"_npmUser":{"name":"traveller","email":"binaryify@gmail.com"},"directories":{},"maintainers":[{"name":"traveller","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/binaryify-awesome-qr_2.1.4_1620042034503_0.3807582569443837"},"_hasShrinkwrap":false,"publish_time":1620042035006,"_cnpm_publish_time":1620042035006,"_cnpmcore_publish_time":"2021-12-16T15:15:47.219Z"}},"readme":"# Awesome-qr.js \r\n\r\n   [](https://www.apache.org/licenses/LICENSE-2.0)\r\n\r\nAn awesome but simple QR code generator written in JavaScript.\r\n\r\n## Gallery \r\n\r\n> These QR codes were made with Awesome-qr.js ????\r\n\r\n\r\n\t\r\n\t\t![](\"art/gallery-1.png\") | \r\n ![](\"art/gallery-2.png\") | \r\n ![](\"art/gallery-3.gif\") | \r\n
\r\n
\r\n\r\n## Contents \r\n\r\n- [Getting Started](#getting-started)\r\n - [Node.js](#nodejs)\r\n - [Browsers](#browsers)\r\n- [Options](#options)\r\n - [text](#text)\r\n - [size](#size)\r\n - [margin](#margin)\r\n - [correctLevel](#correctlevel)\r\n - [maskPattern](#maskpattern)\r\n - [version](#version)\r\n - [components](#components)\r\n - [colorDark](#colordark)\r\n - [colorLight](#colorlight)\r\n - [autoColor](#autocolor)\r\n - [backgroundImage](#backgroundimage)\r\n - [backgroundDimming](#backgrounddimming)\r\n - [gifBackground](#gifbackground)\r\n - [whiteMargin](#whitemargin)\r\n - [logoImage](#logoimage)\r\n - [logoScale](#logoscale)\r\n - [logoMargin](#logomargin)\r\n - [logoCornerRadius](#logocornerradius)\r\n - [dotScale (DEPRECATED)](#deldotscaledel-deprecated)\r\n- [ComponentOptions](#componentoptions)\r\n - [scale](#scale)\r\n - [protectors](#protectors)\r\n- [Sponsors](#sponsors)\r\n- [Changelog](#changelog)\r\n- [Special thanks](#special-thanks)\r\n- [AwesomeQRCode: Designed for Android](#awesomeqrcode-designed-for-android)\r\n- [Other versions](#other-versions)\r\n- [Copyright & License](#copyright--license)\r\n\r\n## Getting Started\r\n\r\n### Node.js\r\n\r\n_Type definitions are included in the npm package._\r\n\r\n> **Please read ⚠️**\r\n>\r\n> Awesome-qr.js uses node-canvas as its drawing backend. You might need to take a look at [its documentation](https://github.com/Automattic/node-canvas#installation) to ensure that node-canvas works on your environment.\r\n\r\n```shell\r\nyarn add awesome-qr // using Yarn\r\nnpm install --save awesome-qr // using NPM\r\n```\r\n\r\n> Awesome-qr.js prior to v2.0.0 **does not work well** in Node.js environment and Awesome-qr.js prior to v1.2.0 **does not work** in Node.js environment.\r\n\r\n```js\r\nconst { AwesomeQR } = require(\"awesome-qr\");\r\nconst fs = require(\"fs\");\r\n\r\n// ...\r\n\r\nconst background = fs.readFileSync(\"background.png\");\r\n\r\nconst buffer = await new AwesomeQR({\r\n text: \"AwesomeQR by Makito - Awesome, right now.\",\r\n size: 500,\r\n backgroundImage: background,\r\n}).draw();\r\n\r\nfs.writeFileSync(\"qrcode.png\", buffer);\r\n```\r\n\r\n### Browsers\r\n\r\n> ⚛️ If you're using React, please use [react-awesome-qr](https://github.com/AwesomeQR/react-awesome-qr).\r\n\r\n```html\r\n\r\n\r\n\r\n\r\n\r\n```\r\n\r\n```js\r\nvar background;\r\nvar reader = new FileReader();\r\nreader.onload = function () {\r\n background = this.result;\r\n new AwesomeQR({\r\n text: \"AwesomeQR by Makito - Awesome, right now.\",\r\n size: 500,\r\n backgroundImage: background,\r\n }).draw().then((dataURL) => );\r\n};\r\nreader.readAsDataURL(file);\r\n```\r\n\r\n## Options\r\n\r\n> _Options_ is an object that you can pass to the generator to customize your QR code.\r\n\r\n```ts\r\ntype Options = {\r\n text: string;\r\n size?: number;\r\n margin?: number;\r\n correctLevel?: number;\r\n maskPattern?: number;\r\n version?: number;\r\n components?: ComponentOptions;\r\n colorDark?: string;\r\n colorLight?: string;\r\n autoColor?: boolean;\r\n backgroundImage?: string | Buffer;\r\n backgroundDimming?: string;\r\n gifBackground?: ArrayBuffer;\r\n whiteMargin?: boolean;\r\n logoImage?: string | Buffer;\r\n logoScale?: number;\r\n logoMargin?: number;\r\n logoCornerRadius?: number;\r\n dotScale?: number; // DEPRECATED!!\r\n};\r\n```\r\n\r\n### text\r\n\r\n**Type** `string`\r\n\r\nText to be encoded in the QR code.\r\n\r\n
\r\n\r\n### size\r\n\r\n**Type** `number?`\r\n\r\n**Default** `400`\r\n\r\nSize of the QR code in pixel.\r\n\r\n
\r\n\r\n### margin\r\n\r\n**Type** `number?`\r\n\r\n**Default** `20`\r\n\r\nSize of margins around the QR code body in pixel.\r\n\r\n
\r\n\r\n### correctLevel\r\n\r\n**Type** `number?`\r\n\r\n**Default** `QRErrorCorrectLevel.M` ~> `0`\r\n\r\n> For more information, please refer to [Error correction feature | QRcode.com | DENSO WAVE](https://www.qrcode.com/en/about/error_correction.html).\r\n\r\nError correction level of the QR code.\r\n\r\n
\r\n\r\n### maskPattern\r\n\r\n**Type** `number?`\r\n\r\n**This is an advanced option.**\r\n\r\nLeave untouched to let the code decide which mask pattern to use.\r\n\r\nSpecify the mask pattern to be used in QR code encoding.\r\n\r\nAccepts a value provided by _QRMaskPattern_.\r\n\r\n> To find out all eight mask patterns, please refer to [Wikipedia File:QR_Code_Mask_Patterns.svg](https://en.wikipedia.org/wiki/File:QR_Code_Mask_Patterns.svg)\r\n\r\n> For more information, please refer to [Reed–Solomon codes for coders: Masking](https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders#Masking).\r\n\r\n
\r\n\r\n### version\r\n\r\n**Type** `number?`\r\n\r\n**This is an advanced option.**\r\n\r\nLeave untouched to let the code decide which version to use.\r\n\r\nSpecify the version to be used in QR code encoding.\r\n\r\nAccepts an integer in range [1, 40].\r\n\r\n**⚠️ An error might occurs if the specified version does not have enough space for the input data.**\r\n\r\n> For more information, please refer to [Information capacity and versions of QR Code | QRcode.com | DENSO WAVE](https://www.qrcode.com/en/about/version.html).\r\n\r\n
\r\n\r\n### components\r\n\r\n**Type** [ComponentOptions](#componentoptions)\r\n\r\nControls the appearances of parts in the QR code.\r\n\r\nRead section [ComponentOptions](#componentoptions) to learn more.\r\n\r\n
\r\n\r\n### colorDark\r\n\r\n**Type** `string?, CSS `\r\n\r\n**Default** `\"#000000\"`\r\n\r\n> For more information about CSS <color>, please refer to [<color> - CSS: Cascading Style Sheets | MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value)\r\n\r\nColor of the blocks on the QR code.\r\n\r\n
\r\n\r\n### colorLight\r\n\r\n**Type** `string?, CSS `\r\n\r\n**Default** `\"#ffffff\"`\r\n\r\nColor of the empty areas on the QR code.\r\n\r\n
\r\n\r\n### autoColor\r\n\r\n**Type** `boolean?`\r\n\r\n**Default** `true`\r\n\r\nAutomatically calculate the _colorDark_ value from the QR code's background.\r\n\r\n
\r\n\r\n### backgroundImage\r\n\r\n**Type** `(string|Buffer)?`\r\n\r\n**Default** `undefined`\r\n\r\nBackground image to be used in the QR code.\r\n\r\nAccepts a `data:` string in web browsers or a Buffer in Node.js.\r\n\r\n
\r\n\r\n### backgroundDimming\r\n\r\n**Type** `string?, CSS `\r\n\r\n**Default** `\"rgba(0, 0, 0, 0)\"`\r\n\r\nColor of the dimming mask above the background image.\r\n\r\n
\r\n\r\n### gifBackground\r\n\r\n**Type** `ArrayBuffer?`\r\n\r\n**Default** `undefined`\r\n\r\nGIF background image to be used in the QR code.\r\n\r\n
\r\n\r\n### whiteMargin\r\n\r\n**Type** `boolean?`\r\n\r\n**Default** `true`\r\n\r\nUse a white margin instead of a transparent one which reveals the background of the QR code on margins.\r\n\r\n
\r\n\r\n### logoImage\r\n\r\n**Type** `(string|Buffer)?`\r\n\r\n**Default** `undefined`\r\n\r\nLogo image to be displayed at the center of the QR code.\r\n\r\nAccepts a `data:` string in web browsers or a Buffer in Node.js.\r\n\r\nWhen set to `undefined` or `null`, the logo is disabled.\r\n\r\n
\r\n\r\n### logoScale\r\n\r\n**Type** `number?`\r\n\r\n**Default** `0.2`\r\n\r\nRatio of the logo size to the QR code size.\r\n\r\n
\r\n\r\n### logoMargin\r\n\r\n**Type** `number?`\r\n\r\n**Default** `6`\r\n\r\nSize of margins around the logo image in pixels.\r\n\r\n
\r\n\r\n### logoCornerRadius\r\n\r\n**Type** `number?`\r\n\r\n**Default** `8`\r\n\r\nCorner radius of the logo image in pixels.\r\n\r\n
\r\n\r\n### dotScale (DEPRECATED)\r\n\r\n**Type** `number?`\r\n\r\n**Default** `0.4`\r\n\r\nUse [components](#components) to control the scaling in a more advanced way.\r\n\r\n> This option is yet to be removed. You can still use this option to control the scaling of the QR code parts in the lagacy way.\r\n\r\nRatio of the real size to the full size of the blocks.\r\n\r\nThis can be helpful when you want to make more parts of the background visible.\r\n\r\n## ComponentOptions\r\n\r\n> _ComponentOptions_ controls the appearances of parts in the QR code.\r\n\r\n```ts\r\ntype ComponentOptions = {\r\n data?: {\r\n scale?: number;\r\n };\r\n timing?: {\r\n scale?: number;\r\n protectors?: boolean;\r\n };\r\n alignment?: {\r\n scale?: number;\r\n protectors?: boolean;\r\n };\r\n cornerAlignment?: {\r\n scale?: number;\r\n protectors?: boolean;\r\n };\r\n};\r\n```\r\n\r\n```ts\r\n// default ComponentOptions\r\n\r\n{\r\n data: {\r\n scale: 0.4,\r\n },\r\n timing: {\r\n scale: 0.5,\r\n protectors: false,\r\n },\r\n alignment: {\r\n scale: 0.5,\r\n protectors: false,\r\n },\r\n cornerAlignment: {\r\n scale: 0.5,\r\n protectors: true,\r\n },\r\n}\r\n```\r\n\r\n### scale\r\n\r\n**Type** `number?`\r\n\r\nScale factor for blocks in the specified area of the QR code.\r\n\r\n
\r\n\r\n### protectors\r\n\r\n**Type** `boolean?`\r\n\r\nControls whether or not to draw the translucent protectors under the specified area in the QR code.\r\n\r\n## Sponsors\r\n\r\nIt is those generous sponsors who supports this project makes the Awesome-qr.js more awesome!\r\n\r\nI'd like to express my sincere appreciation to all the generous sponsors.\r\n\r\n- [Coxxs](https://coxxs.me/)\r\n\r\nSince sponsors' names will not show up here without their permissions, the list above only shows a part of all the sponsors. If you wish to have your name shown up here, please feel free to contact me.\r\n\r\n## Changelog\r\n\r\n[Check the full changelog](CHANGELOG.md)\r\n\r\n## Special thanks\r\n\r\nAwesome-qr.js is inspired by [EFQRCode by EyreFree](https://github.com/EyreFree/EFQRCode).\r\n\r\nEFQRCode is a tool to generate QRCode image or recognize QRCode from image, in Swift.\r\n\r\nIf your application is in need of generating pretty QR codes in Swift, take a look at EFQRCode. It should help.\r\n\r\n## AwesomeQRCode: Designed for Android\r\n\r\nAlso, if you are developing Android apps, you can take a look at [AwesomeQRCode](https://github.com/SumiMakito/AwesomeQRCode), which is designed for Android projects.\r\n\r\n## Other versions\r\n\r\n- React component: [react-awesome-qr](https://github.com/AwesomeQR/react-awesome-qr)\r\n- Vue 2.x component: [Vue-qr](https://github.com/Binaryify/vue-qr)\r\n\r\n## Copyright & License\r\n\r\nAwesome-qr.js is licensed under Apache License 2.0 License.\r\n\r\n```\r\nCopyright (c) 2017-2020 Makito\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n```\r\n\r\n```\r\njquery-qrcode\r\nCopyright (c) 2011 Jerome Etienne, http://jetienne.com\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining\r\na copy of this software and associated documentation files (the\r\n\"Software\"), to deal in the Software without restriction, including\r\nwithout limitation the rights to use, copy, modify, merge, publish,\r\ndistribute, sublicense, and/or sell copies of the Software, and to\r\npermit persons to whom the Software is furnished to do so, subject to\r\nthe following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be\r\nincluded in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\r\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\r\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\r\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\r\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n```\r\n\r\n```\r\nQRCode for JavaScript\r\nCopyright (c) 2009 Kazuhiko Arase\r\nURL: http://www.d-project.com/\r\nLicensed under the MIT license:\r\n http://www.opensource.org/licenses/mit-license.php\r\nThe word \"QR Code\" is registered trademark of\r\nDENSO WAVE INCORPORATED\r\n http://www.denso-wave.com/qrcode/faqpatent-e.html\r\n```\r\n","_attachments":{},"homepage":"https://github.com/SumiMakito/Awesome-qr.js#readme","bugs":{"url":"https://github.com/SumiMakito/Awesome-qr.js/issues"},"license":"Apache-2.0"}