@primecode/async-qrcode
Advanced tools
Comparing version 1.0.3 to 1.0.4
{ | ||
"name": "@primecode/async-qrcode", | ||
"version": "1.0.3", | ||
"version": "1.0.4", | ||
"description": "Async QR code generator, C++ implementation", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -14,2 +14,3 @@ @primecode/async-qrcode | ||
- [API](#api) | ||
- [Webpack](#webpack) | ||
- [Credits](#credits) | ||
@@ -183,5 +184,30 @@ | ||
##### `returns` | ||
Type: `Promise<String>` | ||
```javascript | ||
{ | ||
data: string, //Text to encode | ||
border: number, // Border separator in svg image | ||
type: number, // Types.SQUARE | Types.ROUND | Types.CIRCLE | ||
ecl: number, // Ecl.LOW | Ecl.MEDIUM | Ecl.QUARTILE | Ecl.HIGH, | ||
minVersion: number, // Value between 1 - 40: Increase the error correction level | ||
maxVersion: number, // Value between 1 - 40: Increase the error correction level | ||
mask: number, // User can specify mask pattern manually, value between 0 - 7 | ||
boostEcl: boolean, // User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number | ||
color: string, // Dot color in image | ||
background: string // SVG bacground color | ||
} | ||
``` | ||
## Webpack | ||
```javascript | ||
externals: [ | ||
{ | ||
'@primecode/async-qrcode': 'commonjs @primecode/async-qrcode' | ||
} | ||
] | ||
``` | ||
## Credits | ||
@@ -188,0 +214,0 @@ Software is based on "QRCode c++ library" - Project Nayuki [https://www.nayuki.io/page/qr-code-generator-library](https://www.nayuki.io/page/qr-code-generator-library). |
168581
233