@qrcodesdk/node
Node.js renderers for QRCodeSDK. Use them with @qrcodesdk/core to get a PNG, WebP, GIF, or JPEG
Buffer for files, HTTP responses, downloads, or email attachments.
Install
Section titled “Install”npm install @qrcodesdk/core @qrcodesdk/nodepnpm add @qrcodesdk/core @qrcodesdk/nodevp add @qrcodesdk/core @qrcodesdk/nodedeno add npm:@qrcodesdk/core npm:@qrcodesdk/nodebun add @qrcodesdk/core @qrcodesdk/nodeyarn add @qrcodesdk/core @qrcodesdk/nodeMinimal example
Section titled “Minimal example”import {qrcode} from '@qrcodesdk/core';import {QRCodePNGRenderer} from '@qrcodesdk/node';
const png = qrcode('https://qrcodesdk.dev').render(QRCodePNGRenderer());The result is a Node.js Buffer with a square PNG image. RGB and RGBA colors are kept, including
transparent backgrounds.
Choose a format
Section titled “Choose a format”| Format | Renderer | Content-Type |
Choose it when |
|---|---|---|---|
| PNG | QRCodePNGRenderer |
image/png |
The destination needs the most widely supported raster format |
| WebP | QRCodeWebPRenderer |
image/webp |
The destination accepts WebP and file size matters |
| GIF | QRCodeGIFRenderer |
image/gif |
The destination only accepts GIF |
| JPEG | QRCodeJPEGRenderer |
image/jpeg |
The destination only accepts JPEG, or the center image is a photo |
All four renderers draw the same pixels from the same style and centerImage options.
import {qrcode} from '@qrcodesdk/core';import {QRCodeGIFRenderer, QRCodeJPEGRenderer, QRCodeWebPRenderer} from '@qrcodesdk/node';
const builder = qrcode('https://qrcodesdk.dev');const webp = builder.render(QRCodeWebPRenderer());const gif = builder.render(QRCodeGIFRenderer());const jpeg = builder.render(QRCodeJPEGRenderer({quality: 90}));Format differences:
- WebP is lossless and usually much smaller than PNG.
- GIF is a single frame with at most 256 colors. Pixels with alpha below
transparency.thresholdbecome transparent; all others become opaque. - JPEG is lossy and has no transparency. Transparent pixels blend onto
transparency.matte, white by default.
File sizes for a default QR code for https://qrcodesdk.dev:
| Format | Size |
|---|---|
| WebP | ~310 bytes |
| PNG | ~1.1 KB |
| JPEG | ~9.7 KB |
| JPEG with a module size of 8 | ~870 bytes |
Work with raster output
Section titled “Work with raster output”- Options and constraints: PNG, WebP, GIF, and JPEG Buffer renderers.
- Center images: create one from PNG bytes with
rasterCenterImage(). It works with all four renderers. See Add a center image. - Write a Buffer to disk: Download or save.
- Return it from an HTTP handler: Serve a QR code.
Runtime requirements
Section titled “Runtime requirements”- Node.js 22.0.0 or newer; tested on 22, 24, and 26.
- Deno (current stable major) and Bun (current stable release), through their Node.js compatibility layers.
- Not for browsers: use
@qrcodesdk/browserthere. Edge workers are untested. - TypeScript: the public API uses Node’s global
Buffertype. Add@types/nodeto your development dependencies and enable Node types in your TypeScript options.
Public API
Section titled “Public API”import { QRCodeGIFRenderer, type QRCodeGIFRendererOptions, QRCodeJPEGRenderer, type QRCodeJPEGRendererOptions, QRCodePNGRenderer, type QRCodePNGRendererOptions, type QRCodeRasterCenterImage, type QRCodeRasterRendererOptions, QRCodeWebPRenderer, type QRCodeWebPRendererOptions, rasterCenterImage,} from '@qrcodesdk/node';@qrcodesdk/node
- Version
- v0.0.6
- Downloads
- 724/mo
- Install size
- 28.6 kB
- Bundled size
- 14.3 kB
Works with


Related pages
Section titled “Related pages”Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!