denorg / qrcode Goto Github PK

View Code? Open in Web Editor NEW

44.0 9.0 11.0 137 KB

📇 Generate QR code images in Deno

Home Page: https://denorg.github.io/qrcode/

License: MIT License

TypeScript 15.29% JavaScript 84.71%

deno denoland denorg typescript qrcode qrcode-generator hacktoberfest hacktoberfest2023

qrcode's Introduction

📇 QR Code

Generate QR codes in Deno, as base64-encoded images, completely dependency-free and requires no binary.

This is a port of zenozeng/node-yaqrcode, which itself is a port of the QR code generator in the d-project.

⭐ Getting started

import { qrcode } from "https://deno.land/x/qrcode/mod.ts";
const base64Image = qrcode("bitcoin:ADDRESS?amount=0.5&label=ORDER"); // data:image/gif;base64,...

You can also add a custom size by specifying size in the second parameter:

const fixedSizeImage = await qrcode("bitcoin:ADDRESS?amount=0.5&label=ORDER", { size: 500 });

CLI with DPX

After installing DPX, you can directly use the CLI using the dpx command:

dpx qrcode <text>

CLI

Alternatively, you can use it directly from the CLI by using deno run:

deno run https://deno.land/x/qrcode/cli.ts <text>

You can also install it globally using the following:

deno install https://deno.land/x/qrcode/cli.ts

Then, the package is available to run:

qrcode <text>

👩‍💻 Development

Run tests:

deno test

Notes

To support typeNumber 40, use the RS_BLOCK_TABLE from davidshimjs/qrcodejs
To support UTF-8, use the code from davidshimjs/qrcodejs
Returns a base64-encoded image URL

⭐ Related Work

zenozeng/node-yaqrcode is the Node.js project that is the origin of this implementation

📄 License

MIT © Denorg
Original repo: MIT © Zeno Zeng
"QR Code" is registered trademark of Denso Wave

_{A project by Denorg, the world's first Deno-focused community
organization and consulting company. Work with us →}

qrcode's People

Contributors

Stargazers

Watchers

Forkers

michael-spengler iamcmnut moncefplastin07 adaamz ritm1993 jcc10 dobromyslov roziscoding archweii jj

qrcode's Issues

默认返回gif格式的base64，有没有参数指定或修改返回的格式？

data:image/gif;base64,base64编码的gif图片数据
data:image/png;base64,base64编码的png图片数据

A bit of more documentation would help

For instance, document the fact that qrcode is asynchronous, or that it returns a QRCode class which seems to be a string, or at least can be converted to string.

Update README template

We have a new, updated README template in https://github.com/denorg/starter that has guides about DPX, a Deno footer, and some new sections. Please update this project's README to match the new template. As an example, I've updated this one: https://github.com/denorg/is-docker.

Audit underlying JS code

For starters, it's 15-year old code. Refactoring it to common practices today
would probably make it easier to understand, and work on it. But, more
importantly, it would allow exposition of the functionality that's there and
which is so far not being tapped.

Question: Do you plan to publish this module also via https://nest.land/ ?

https://nest.land/

Could I use this to create a jpg files?

I want to use node to create some qrcode jpg files, and then I find this library. But I don't know how to use it to create the jpg files.

Deno.serve QRCode Server Example for All

The following code snippet serves a QRCode using Deno.

URL Params Example:

http://localhost:4000/?d=Hello+World!&v=5&e=L&s=250&m=Byte

import { qrcode } from "https://deno.land/x/qrcode/mod.ts";
import { decodeBase64 } from "https://deno.land/[email protected]/encoding/base64.ts";

// Deno.serve() handler
async function handler(request: Request, connInfo: Deno.ServeHandlerInfo): Promise<Response> {

  // Information for a HTTP request.
  const remoteAddr = connInfo.remoteAddr;

  const url = new URL(request.url);
  // Data to encode...
  const d = url.searchParams.get("d") || "Hello World!";
  // Version of barcode 0 (Automatic type number) - 40
  // https://www.qrcode.com/en/about/version.html
  const v = Math.min(40, Math.max(0, Number(url.searchParams.get("v")) || 0));
  // Error Correction L = 7% | M = 15% | Q = 25% | H = 30%
  const e = ["L", "M", "Q", "H"].includes(url.searchParams.get("e")) ? url.searchParams.get("e") : "M";
  // Size of barcode 250 - 500
  const s = Math.min(500, Math.max(250, Number(url.searchParams.get("s")) || 250));
  // Mode = 'Numeric' | 'Alphanumeric' | 'Byte' | 'Kanji'
  const m = ['Numeric', 'Alphanumeric', 'Byte', 'Kanji'].includes(url.searchParams.get("m")) ? url.searchParams.get("m") : "Byte";

  const base64Image = await qrcode(d, { typeNumber: v, errorCorrectLevel: e, size: s, mode: m }); // data:image/gif;base64,...
  const binaryImage = new Uint8Array(decodeBase64(base64Image.split(",")[1]));

  return new Response(binaryImage, {
    status: 200,
    headers: {
      "Server": `Deno v${Deno.version.deno}`,
      "Allow": "HEAD, GET, OPTIONS",
      "Cache-Control": "no-store",
      "Content-Language": "en-US",
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Methods": "HEAD, GET, OPTIONS",
      "Access-Control-Allow-Headers": "Content-Type",
      "Access-Control-Allow-Credentials": "false",
      "Content-Type": "image/gif",
    },
  })

}

// Start the QRCode server of Port 4000
Deno.serve({
  port: 4000,
  hostname: "0.0.0.0",
  onListen({ port, hostname }) {
    console.log(`Application..... QR Code - Model 2 - A QR Code Model 2 Server
Deno v${Deno.version.deno} : Typescript v${Deno.version.typescript} : V8 v${Deno.version.v8}
Permissions..... --allow-net
Gateway URL..... http://${hostname}:${port}\n\n`);
  },
  onError(error: unknown) {
    console.error(error);
    return new Response("HTTP 500: Internal Server Error", {
      status: 500,
      headers: { "Content-Type": "text/plain" },
    });
  },
}, handler);

// deno run --allow-net qrServe.ts

Hello World!

Publish up-to-date code on https://deno.land/x/qrcode

Branch master is 5 commits ahead of the latest available release 2.0.0 on https://deno.land/x/qrcode, and includes a fix for the incorrect return type of function qrcode(). Please release a new version on https://deno.land/x/qrcode that includes this fix.