1.0.2 • Published 12 months ago
node-vietqr v1.0.2
#Features Support draw QR code from data bank ( accountName, amount, memo,....) with many templates
Installation
Npm install:
npm install node-vietqr
Use
import { generateQRCode } from 'node-vietqr'
import path from 'path'
import { fileURLToPath } from 'url';
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
generateQRCode(
{
bankCode: '970418',
bankAccountNumber: '12345678999',
amount: 1000000,
description: 'Thanh toan hoa don',
},
{
width: 400,
height: 400,
padding: 16,
bgColor: '#111729',
qrColor: '#ffffff',
output: path.join(__dirname, './qrcode.png'),
}
)
PaymentInfoConfig
Property | Type | Default Value | Description | Example |
---|---|---|---|---|
bankCode | string | Bank Identification Numbers. List bank code | Sacombank - 970403 | |
bankAccountNumber | string | Bank account number | ||
amount | number |undefined | undefined | Transaction amount | |
description | string |undefined | undefined | Transaction content | |
qrMethod | 'static'|'dynamic' | 'static' | static : Static QR – apply when allows a QR code to process more than one transaction. dynamic : Dynamic QR – apply when allow a QR code to process only one transaction. |
Option
Property | Type | Default Value | Description | Example |
---|---|---|---|---|
width | number | 400 | Width of QRCode image | |
height | number | 400 | Height of QRCode image | |
padding | number | 16 | Padding of QRCode image | |
bgColor | string | #111729 | Background color | |
qrColor | string | #ffffff | QRcode color | |
textColor | string |undefined | Text color | ||
textPosition | number |undefined | Text position in QRcode image | ||
textSize | number |undefined | Text size | ||
textValue | string |undefined | Text value | ||
fontFamily | string |undefined | Font family | ||
logoPath | string |undefined | Logo file path will show in the center of QRcode | ||
logoWidth | number |undefined | Logo width | ||
output | string |undefined | QRcode file path output |