jsqr
- Version 1.4.0
- Published
- 280 kB
- No dependencies
- Apache-2.0 license
Install
npm i jsqr
yarn add jsqr
pnpm add jsqr
Overview
A pure javascript QR code reading library that takes in raw images and will locate, extract and parse any QR code found within.
Index
Functions
Interfaces
Functions
function jsQR
jsQR: ( data: Uint8ClampedArray, width: number, height: number, providedOptions?: Options) => QRCode | null;
Interfaces
interface Options
interface Options {}
property inversionAttempts
inversionAttempts?: 'dontInvert' | 'onlyInvert' | 'attemptBoth' | 'invertFirst';
interface QRCode
interface QRCode {}
property binaryData
binaryData: number[];
property chunks
chunks: Chunks;
property data
data: string;
property location
location: { topRightCorner: Point; topLeftCorner: Point; bottomRightCorner: Point; bottomLeftCorner: Point; topRightFinderPattern: Point; topLeftFinderPattern: Point; bottomLeftFinderPattern: Point; bottomRightAlignmentPattern?: Point;};
property version
version: number;
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (13)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/jsqr
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/jsqr)
- HTML<a href="https://www.jsdocs.io/package/jsqr"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2319 ms. - Missing or incorrect documentation? Open an issue for this package.