0.3.0 • Published 12 months ago

qr-common-uri v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

qr-common-uri

npm CI

QR codes can contain plain text as well as a variety of standardized URI's. Each URI's scheme can open commonly used applications on desktop and mobile devices.

A couple examples:

  • mailto:... - opens the devices email client with auto-populated fields.
  • tel:... - opens the devices phone app with the number specified either pre-filled or calling.

The format and parameters of each scheme isn't clear and the documentation of which is a bit scattered especially schemes valid for use in QR codes. This package provides utility functions for generating these URIs without having to research their formats and valid parameters.

Many of the functions in this package reference schemes from https://github.com/zxing/zxing/wiki/Barcode-Contents.

Install

npm

npm install qr-common-uri

yarn

yarn add qr-common-uri

pnpm

pnpm install qr-common-uri