Add docs everywhere. Upgrade to ts 6.0-rc, jsbt 0.5. Add pkg.json scripts.

Author: paulmillr

README.md

@@ -76,25 +76,30 @@ const larger = encodeQR(txt, 'gif', { scale: 4 });
 // };
 
 console.log(ascii);
-> █████████████████████████████████████
-> ██ ▄▄▄▄▄ █  ▀▄▄█ ██▀▄▄▄▄█ ▀█ ▄▄▄▄▄ ██
-> ██ █   █ █▀▄▀▄ ▄▄█▄█ ██▀█▀▀█ █   █ ██
-> ██ █▄▄▄█ ██ ▄▄█▄▀▀ ▀ ██ ▄ ▄█ █▄▄▄█ ██
-> ██▄▄▄▄▄▄▄█ ▀ ▀ █▄▀ ▀ ▀▄█ █ █▄▄▄▄▄▄▄██
-> ██ █  ▀ ▄▄▀▀▀ █▀ ▄   ▀▀▄▀ ▄█ ▀█ ▀▄▄██
-> ██▀▀▀  ▀▄▄██▄▀▀▄█▀ ▀▄█    ▀▀▀ ▄ █▄▄██
-> █████▄▀▀▄▄██ ▀ ▀ ▄▄██▄ ▄▄ ▄ █▀█ █ ███
-> ███   ▄▀▄█▄▄▄█   ▀██▄▄▄▀▀█▄▀ ▄█▀ ████
-> ██▀▀ ▄ ▀▄ ▄▄██▀▄▀▀████▄▄▄ █▄ █  █▀▀██
-> ██▀▀▄ ▄▀▄ ▀▀█▄▀▀▄▄▀▀ █▄▄▀█▀ ▀▄ █▄ ▀██
-> ██▀▄▀██ ▄▄ ▀█▄█▀ ▀ ▀█▄▀▀ █▄▀▀ █  █ ██
-> ███▀█▄▀▄▄ █  █ ██ ██ ▄ █ ▄▄▄ ▄▀▀▄▄ ██
-> ██▄█▄▄▄█▄█ ▄ ▄▀█▀▀ ▄▀ █▀ ▄ ▄▄▄ ▀▄▀▄██
-> ██ ▄▄▄▄▄ █ ▄█▄▀▀ ▀█   █▄█  █▄█ ▀▀▄▀██
-> ██ █   █ █▀ ▄▀█ ██ ▄▄▀██   ▄▄ ▄█   ██
-> ██ █▄▄▄█ █▄  ██▀ ▄▄ ▀█ ▄      ▀▄▄█▀██
-> ██▄▄▄▄▄▄▄█▄███▄█▄█▄▄▄▄█▄█▄████▄▄█████
-> ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
+```
+
+Example output:
+
+```text
+█████████████████████████████████████
+██ ▄▄▄▄▄ █  ▀▄▄█ ██▀▄▄▄▄█ ▀█ ▄▄▄▄▄ ██
+██ █   █ █▀▄▀▄ ▄▄█▄█ ██▀█▀▀█ █   █ ██
+██ █▄▄▄█ ██ ▄▄█▄▀▀ ▀ ██ ▄ ▄█ █▄▄▄█ ██
+██▄▄▄▄▄▄▄█ ▀ ▀ █▄▀ ▀ ▀▄█ █ █▄▄▄▄▄▄▄██
+██ █  ▀ ▄▄▀▀▀ █▀ ▄   ▀▀▄▀ ▄█ ▀█ ▀▄▄██
+██▀▀▀  ▀▄▄██▄▀▀▄█▀ ▀▄█    ▀▀▀ ▄ █▄▄██
+█████▄▀▀▄▄██ ▀ ▀ ▄▄██▄ ▄▄ ▄ █▀█ █ ███
+███   ▄▀▄█▄▄▄█   ▀██▄▄▄▀▀█▄▀ ▄█▀ ████
+██▀▀ ▄ ▀▄ ▄▄██▀▄▀▀████▄▄▄ █▄ █  █▀▀██
+██▀▀▄ ▄▀▄ ▀▀█▄▀▀▄▄▀▀ █▄▄▀█▀ ▀▄ █▄ ▀██
+██▀▄▀██ ▄▄ ▀█▄█▀ ▀ ▀█▄▀▀ █▄▀▀ █  █ ██
+███▀█▄▀▄▄ █  █ ██ ██ ▄ █ ▄▄▄ ▄▀▀▄▄ ██
+██▄█▄▄▄█▄█ ▄ ▄▀█▀▀ ▄▀ █▀ ▄ ▄▄▄ ▀▄▀▄██
+██ ▄▄▄▄▄ █ ▄█▄▀▀ ▀█   █▄█  █▄█ ▀▀▄▀██
+██ █   █ █▀ ▄▀█ ██ ▄▄▀██   ▄▄ ▄█   ██
+██ █▄▄▄█ █▄  ██▀ ▄▄ ▀█ ▄      ▀▄▄█▀██
+██▄▄▄▄▄▄▄█▄███▄█▄█▄▄▄▄█▄█▄████▄▄█████
+▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
 ```
 
 ## Decoding
@@ -143,21 +148,23 @@ function decodeWithExternal() {
 ### Decoding options
 
 ```ts
-export type Point4 = { x: number; y: number }[];
-export type Image = {
+type Point = { x: number; y: number };
+type Pattern = Point & { moduleSize: number; count: number };
+type FinderPoints = [Pattern, Pattern, Point, Pattern];
+type Image = {
   height: number;
   width: number;
   data: Uint8Array | Uint8ClampedArray | number[];
 };
-export type DecodeOpts = {
-  // By default we assume that image has 4 channel per pixel (RGBA). isRGB: true will force to use only one
-  isRGB?: boolean;
-  // Returns 4 center (3 finder pattern + 1 alignment pattern) points if detected
-  detectFn?: (points: Point4) => void;
-  // Returns RGBA image of detected QR code
-  qrFn?: (img: Image) => void;
+type DecodeOpts = {
+  cropToSquare?: boolean;
+  textDecoder?: (bytes: Uint8Array) => string;
+  pointsOnDetect?: (points: FinderPoints) => void;
+  imageOnBitmap?: (img: Image) => void;
+  imageOnDetect?: (img: Image) => void;
+  imageOnResult?: (img: Image) => void;
 };
-export default function decodeQR(img: Image, opts: DecodeOpts = {});
+declare function decodeQR(img: Image, opts?: DecodeOpts): string;
 ```
 
 ### Decoding algorithm

package-lock.json

@@ -20,14 +20,18 @@
     "LICENSE-MIT"
   ],
   "devDependencies": {
-    "@paulmillr/jsbt": "0.4.5",
-    "@types/node": "24.2.1",
+    "@paulmillr/jsbt": "0.5.0",
+    "@types/node": "25.3.0",
     "prettier": "3.6.2",
-    "typescript": "5.9.2"
+    "typescript": "6.0.1-rc"
   },
   "scripts": {
     "build": "tsc",
     "build:release": "npx --no @paulmillr/jsbt esbuild test/build",
+    "check": "npm run check:readme && npm run check:treeshake && npm run check:jsdoc",
+    "check:readme": "npx --no @paulmillr/jsbt readme package.json",
+    "check:treeshake": "npx --no @paulmillr/jsbt treeshake package.json test/build/out-treeshake",
+    "check:jsdoc": "npx --no @paulmillr/jsbt tsdoc package.json",
     "bench": "cd test/benchmark && npm ci && node index.ts",
     "format": "prettier --write src",
     "test": "cd test; npm ci; node --experimental-strip-types --no-warnings index.ts",

package.json

@@ -17,10 +17,6 @@ limitations under the License.
 /**
  * Methods for decoding (reading) QR code patterns.
  * @module
- * @example
-```js
-
-```
  */
 
 import type { EncodingType, ErrorCorrection, Image, Mask, Point } from './index.ts';
@@ -53,6 +49,7 @@ for (let i = 0; i < SUM16.length; i++) {
 const int = (n: number) => n >>> 0;
 
 type Point4 = [Point, Point, Point, Point];
+/** Finder and alignment points returned by the detector. */
 export type FinderPoints = [Pattern, Pattern, Point, Pattern];
 // distance ^ 2
 const distance2 = (p1: Point, p2: Point) => {
@@ -1182,12 +1179,35 @@ function decodeBitmap(
   return res;
 }
 
+/** QR decoding hooks and image preprocessing options. */
 export type DecodeOpts = {
+  /** Crop rectangular inputs to a centered square before decoding. */
   cropToSquare?: boolean;
+  /**
+   * Custom byte-to-text decoder used for byte segments.
+   * @param bytes - Byte segment to decode.
+   * @returns Decoded text.
+   */
   textDecoder?: (bytes: Uint8Array) => string;
+  /**
+   * Callback invoked with finder/alignment points after detection succeeds.
+   * @param points - Finder and alignment points returned by the detector.
+   */
   pointsOnDetect?: (points: FinderPoints) => void;
+  /**
+   * Callback invoked with the grayscale bitmap that the detector sees.
+   * @param img - Grayscale image generated during bitmap conversion.
+   */
   imageOnBitmap?: (img: Image) => void;
+  /**
+   * Callback invoked with the perspective-corrected QR image.
+   * @param img - Perspective-corrected QR image.
+   */
   imageOnDetect?: (img: Image) => void;
+  /**
+   * Callback invoked with the final decoded QR image.
+   * @param img - Final QR image used to decode the payload.
+   */
   imageOnResult?: (img: Image) => void;
 };
 
@@ -1211,6 +1231,22 @@ function cropToSquare(img: Image) {
   return { offset, img: { height: squareSize, width: squareSize, data: croppedData } };
 }
 
+/**
+ * Decode text from a QR image.
+ * @param img - RGB or RGBA image data that contains a QR code.
+ * @param opts - Decoder hooks and image preprocessing options. See {@link DecodeOpts}.
+ * @returns Decoded QR payload as a string.
+ * @throws If the image, decoder options, or QR contents are invalid. {@link Error}
+ * @example
+ * Decode text from a QR image.
+ * ```ts
+ * import encodeQR, { Bitmap } from 'qr';
+ * import decodeQR from 'qr/decode.js';
+ * const bits = encodeQR('Hello world', 'raw', { scale: 4 });
+ * const bm = new Bitmap({ width: bits[0].length, height: bits.length }, bits);
+ * const text = decodeQR(bm.toImage());
+ * ```
+ */
 export function decodeQR(img: Image, opts: DecodeOpts = {}): string {
   for (const field of ['height', 'width'] as const) {
     if (!Number.isSafeInteger(img[field]) || img[field] <= 0)
@@ -1240,6 +1276,22 @@ export function decodeQR(img: Image, opts: DecodeOpts = {}): string {
   return res;
 }
 
+/**
+ * Default export alias for {@link decodeQR}.
+ * @param img - RGB or RGBA image data that contains a QR code.
+ * @param opts - Decoder hooks and image preprocessing options. See {@link DecodeOpts}.
+ * @returns Decoded QR payload as a string.
+ * @throws If the image, decoder options, or QR contents are invalid. {@link Error}
+ * @example
+ * Decode a rendered QR image via the default decoder export.
+ * ```ts
+ * import encodeQR, { Bitmap } from 'qr';
+ * import decodeQR from 'qr/decode.js';
+ * const bits = encodeQR('Hello world', 'raw', { scale: 4 });
+ * const bm = new Bitmap({ width: bits[0].length, height: bits.length }, bits);
+ * decodeQR(bm.toImage());
+ * ```
+ */
 export default decodeQR;
 
 // Unsafe API utils, exported only for tests