• Version 1.4.0
  • Published
  • 280 kB
  • No dependencies
  • Apache-2.0 license


npm i jsqr
yarn add jsqr
pnpm add jsqr


A pure javascript QR code reading library that takes in raw images and will locate, extract and parse any QR code found within.



function jsQR

jsQR: (
data: Uint8ClampedArray,
width: number,
height: number,
providedOptions?: Options
) => QRCode | null;


    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.


                    To add a badge like this onejsDocs.io badgeto 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
                    • HTML
                      <a href="https://www.jsdocs.io/package/jsqr"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>