qrcode-matrix 0.1.1 → 1.0.0-beta.2

package/README.md

@@ -1,50 +1,65 @@
 # qrcode-matrix
-> `qrcode-matrix` 是QR码矩阵数据生成库, 最终生成QR码的二维数组.
-> 非一步一位生成二维码图片, 主要用于二维码图片生成/美化, 矢量图片二维码生成等场景
+> `qrcode-matrix` 是QR码矩阵数据生成库, 最终生成QR码的点阵.
+> 非一步到位生成二维码图片, 主要用于二维码图片生成/美化, 矢量图片二维码生成等场景
 
 特点:  
-`splitMake` 方法, 会返回二维码不同功能的点阵信息二维数组.
-
-## 相关网站
-[二维码美化](http://www.whyoop.com/tool-qr)
+- `splitMake` 方法, 会返回二维码不同功能的点阵信息数组.
+- 支持转为`GBK`编码保存(实际上已经剥离出了数据转换部份,存任何编码方式都很方便)
+- 提供精简版(gzip 5.2k),只保留`Byte`(utf8)模式;
+	- './onlyUTF8.js' or './dist/qrcodeMatrix.utf8.js'
 
+> 生成的点阵用的是[BitMatrix](https://github.com/cnwhy/BitMatrix)库，其基于`ArrayBuffer`实现以节约内存，但只适用于`ES6`以上的环境。
 ## demo
 ```js
-var QRCode = require('qrcode.js');
+var QRCode = require('../').default;
 var qrcode = QRCode({
-	errorCorrectionLevel: "M", //纠错等级 默认M   'L','M','Q','H' -> [1,0,3,2]
-	typeNumber: 0,             //QR码版本 默认0 (自动)  1 to 40
-	minTypeNumber: 0,          //最小typeNumber版本,当typeNumber自动时生效
-	maskPattern: 'auto',       //掩模 'random','auto'  [0-7]
-	dataMode: 'Byte'           //默认数据类型 结合 QRModes 参数
-})
+	errorCorrectionLevel: 'M', //纠错等级 默认M   'L','M','Q','H' -> [1,0,3,2]
+	typeNumber: 2, //QR码版本 默认0 (自动)  1 to 40
+	minTypeNumber: 0, //最小typeNumber版本,当typeNumber自动时才有效
+	maskPattern: 'auto', //掩模 'random','auto'  [0-7]
+	dataMode: 'Byte' //默认数据类型, 参看 QRCode.QRModes 对像
+});
 qrcode.setData('1234');
-var date = qrcode.make(); // 一个布尔值的二维数组
-date.forEach(function(v,i){
-	console.log(v.map(function(item){return item?'☐':'◼︎'}).join(' '))
-})
+var matrix = qrcode.make(); // 一个布尔值的二维点阵对像
+
+//在控制台打印出二维码试试 (我的控制台是黑色背景,所以我加上了一圈边框)
+var $0 = '8 ',
+    $1 = '  ';
+console.log($0.repeat(matrix.width + 2));
+for(var r =0; r<matrix.height; r++){
+	let row = matrix.getRow(r);
+	let str = row.map(item => (item ? $1 : $0)).join('');
+	console.log($0 + str + $0);
+}
+console.log($0.repeat(matrix.width + 2));
 /*
-☐ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ☐ ☐ ☐ ☐ ☐
-☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐
-☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐
-☐ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ☐ ☐ ☐ ☐
-◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎
-☐ ◼︎ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎
-☐ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ☐
-◼︎ ◼︎ ☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ◼︎
-☐ ☐ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ☐ ◼︎ ☐ ☐ ◼︎
-◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ◼︎ ◼︎ ◼︎
-◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ◼︎ ☐ ☐ ☐
-☐ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎ ◼︎
-☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ◼︎
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ◼︎
-☐ ◼︎ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎
-☐ ◼︎ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ☐ ◼︎ ◼︎ ◼︎ ◼︎ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎
-☐ ☐ ☐ ☐ ☐ ☐ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ◼︎ ◼︎ ☐ ◼︎ ☐ ☐ ◼︎
+8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8
+8               8               8   8               8
+8   8 8 8 8 8   8 8 8 8 8 8       8 8   8 8 8 8 8   8
+8   8       8   8 8   8     8   8 8 8   8       8   8
+8   8       8   8     8 8 8 8 8 8 8 8   8       8   8
+8   8       8   8     8     8 8 8 8 8   8       8   8
+8   8 8 8 8 8   8       8 8 8 8 8   8   8 8 8 8 8   8
+8               8   8   8   8   8   8               8
+8 8 8 8 8 8 8 8 8     8   8   8     8 8 8 8 8 8 8 8 8
+8   8 8 8   8       8     8   8 8 8           8 8   8
+8   8       8 8     8   8       8   8   8 8 8 8   8 8
+8 8     8               8   8 8 8     8 8   8 8   8 8
+8 8 8 8   8 8 8 8 8   8     8   8 8 8 8             8
+8 8   8 8 8 8   8   8 8   8         8   8       8   8
+8     8 8   8 8 8 8     8   8 8 8 8           8   8 8
+8 8 8       8         8           8 8     8       8 8
+8 8 8     8 8 8 8 8 8 8   8   8         8 8     8 8 8
+8     8     8   8 8     8     8 8           8 8 8   8
+8 8 8 8 8 8 8 8 8   8   8 8     8   8 8 8         8 8
+8               8   8   8 8 8 8     8   8     8   8 8
+8   8 8 8 8 8   8 8   8 8   8   8   8 8 8   8 8   8 8
+8   8       8   8   8     8                 8 8     8
+8   8       8   8 8     8   8 8 8     8     8 8 8   8
+8   8       8   8 8             8 8   8     8     8 8
+8   8 8 8 8 8   8 8 8     8   8 8     8 8         8 8
+8               8       8     8 8 8     8 8   8     8
+8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8
 */
 ``` 
 
@@ -80,9 +95,9 @@ console.log(Object.keys(QRCode_utf8.QRModes));
 
 ### qrcode.addData(data,mode) //添加数据 可以多次添加
 
-### qucode.setData(data,mode) //重新添加数据 会移出之前的数据
+### qucode.setData(data,mode) //重新添加数据 会移除之前的数据
 
-### qucode.make() //根据添加的数生成QR码的二维数组
+### qucode.make() //根据添加的数据生成QR码的二维点阵对像
 
 ### qucode(data,mode) //一个语法糖
 ```js
@@ -92,7 +107,7 @@ return qucode.make();
 ```
 
 ### qucode.splitMake() //拆分QR码的二维数组 将返回一个对像
- - `all` : 所有数据 `make` 方法返回的二维矩阵相同
+ - `all` : 所有数据 `make` 方法返回的二维点阵相同
  - `data` : 除探测相并数据 的其它数据
  - `allDiscover` : 所有定位,矫正 等数据
  - `positionProbe` : 定位图数据
@@ -104,4 +119,7 @@ return qucode.make();
 ```js
 all  == data | allDiscover
 allDiscover == positionProbe | positionAdjust | timing
-```
+```
+
+## 相关应用
+[二维码美化](http://qr.whyoop.com)