@shreyaadhikari/qr-code-generator
v1.0.17
Published
A utility package to generate QR codes
Downloads
25
Maintainers
shreyaadhikariReadme
QR Code Generator
Description
QR Code Generator is a simple Node.js package for generating QR codes and saving them as image files. Ideal for adding QR code functionality to your Node.js applications effortlessly.
Table of Contents
Features
- Generate QR Codes: Easily generate QR codes from text.
- Save as Image: Save the generated QR codes directly to image files (PNG format).
Installation
You can install this package using npm:
npm install @shreyaadhikari/qr-code-generatorUsage
Here’s a quick guide on how to use the QR Code Generator in your Node.js project.
Import the package
const generateQRCode = require('@shreyaadhikari/qr-code-generator');Generate and Save a QR Code
const text = 'Hello World';
const outputPath = 'qrcode.png';
generateQRCode(text, outputPath, (err, message) => {
if (err) {
console.error('Error generating QR code:', err);
} else {
console.log(message); // Output: 'QR Code saved to qrcode.png'
}
});- text: The text you want to encode into a QR code.
- outputPath: The path where the QR code image will be saved.
- callback: A function that handles the success or error response.
Example Usage
Here is a complete example using a file named test.js:
const generateQRCode = require('@shreyaadhikari/qr-code-generator');
const text = 'Hello World';
const outputPath = 'qrcode.png';
generateQRCode(text, outputPath, (err, message) => {
if (err) {
console.error('Error generating QR code:', err);
} else {
console.log(message); // Output: 'QR Code saved to qrcode.png'
}
});Usage in Different Environments
Node.js
This package is designed for use with Node.js. See the Usage section for examples.
Browser
To use this package in a browser, include the script tag as follows:
<script src="https://cdn.jsdelivr.net/npm/@yourusername/qr-code-generator"></script>Example Usage in a browser
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>QR Code Generator</title>
</head>
<body>
<input type="text" id="textInput" placeholder="Enter text for QR Code">
<button id="generateButton">Generate QR Code</button>
<img id="qrCodeImage" alt="QR Code">
<script src="https://cdn.jsdelivr.net/npm/@shreyaadhikari/qr-code-generator"></script>
<script>
document.getElementById('generateButton').addEventListener('click', () => {
const text = document.getElementById('textInput').value;
const outputPath = 'data:image/png;base64,'; // QR code will be displayed as a base64-encoded PNG
generateQRCode(text, outputPath, (err, imageSrc) => {
if (err) {
console.error('Error generating QR code:', err);
} else {
document.getElementById('qrCodeImage').src = imageSrc;
}
});
});
</script>
</body>
</html>Dependencies
This package requires the following dependencies:
Credits
- Special thanks to the QRCode library for providing QR code generation functionality.
FAQ
Q: What if I encounter an error generating the QR code?
A: Make sure the text input is a valid string and check the file path permissions.
Contributing
Contributions are welcome! If you want to improve this package, follow these steps:
- Fork the repository.
- Create a new branch (git checkout -feature-branch).
- Make your changes.
- Commit your changes (git commit -am 'Add new feature').
- Push to the branch (git push origin feature-branch).
- Create a pull request.
License
This package is licensed under the ISC License. See the LICENSE file for details.
Contact
For questions or suggestions, feel free to open an issue on the GitHub repository or contact me at [email protected].