@ronnieacs/styled-qr-code-node
v0.1.2
Published
Add a style and an image to your QR code
Downloads
11
Maintainers
Readme
QR Code Styling
JavaScript library for generating QR codes with a logo and styling.
This is a NodeJS fork of the QR code styling repo qr-code-styling, supporting NodeJs as well as svg exports. If you are looking for browser support head to the original project
Try it here https://qr-code-styling.com
If you have issues / suggestions / notes / questions, please open an issue or contact me. Let's create a cool library together.
Examples
Installation
npm install @loskir/styled-qr-code-node
Usage
import {QRCodeCanvas} from '@loskir/styled-qr-code-node';
const {QRCodeCanvas} = require('@loskir/styled-qr-code-node'); // or CommonJS
const qrCode = new QRCodeCanvas({
data: 'My text or trl',
image: 'pathToImage'
});
//"png" | "jpg" | "jpeg" | "pdf" | "svg"
await qrCode.toFile('output.png', 'png');
API Documentation
Styling options
Export methods
qrCode.toFile(options) => Promise<void>
| Param | Type | Default Value | Description |
| -------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| filePath | string | | the path where the image will be saved |
| format | string ("png" / "jpg" / "jpeg" / "pdf" / "svg"
) | 'png'
| File format |
| options | skia-canvas RenderOptions | undefined | see doc |
qrCode.totoDataUrl(options) => Promise<string>
| Param | Type | Default Value | Description |
| -------- |----------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------|
| format | string ("png" / "jpg" / "jpeg" / "pdf" / "svg"
) | 'png'
| File format |
| options | skia-canvas RenderOptions | undefined | see doc |
qrCode.toBuffer(options) => Promise<Buffer>
| Param | Type | Default Value | Description |
| -------- |----------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------|
| format | string ("png" / "jpg" / "jpeg" / "pdf" / "svg"
) | 'png'
| File format |
| options | skia-canvas RenderOptions | undefined | see doc |