From 1671f19bc24f9c283fd9ef48cef90cd208329afb Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Wed, 8 Apr 2026 19:19:35 -0600 Subject: [PATCH] Fix api formatting docs --- docs/Plugin API/documentscanner.md | 40 ++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/docs/Plugin API/documentscanner.md b/docs/Plugin API/documentscanner.md index 7b944f2..0682b73 100644 --- a/docs/Plugin API/documentscanner.md +++ b/docs/Plugin API/documentscanner.md @@ -17,19 +17,21 @@ Get a list of document scanners found on the network. Supports eSCL/AirPrint. **Kind**: static method of [documentscanner](#documentscanner) **Example** ```js +await global.apis.documentscanner.discoverScanners(); +// Returns: [{ - protocol: "http", - host: "ip or hostname", - port: 80, - rs: "eSCL", - uuid: "1234etc", - icon: "http://hostname/icon.png", // Icon supplied by the scanner to represent itself visually to the user. - name: "ScanTron 9000", - note: "", // Whatever is set as the scanner's human-readable location in its settings - hasAdf: true, // Has an automatic document/page feeder - hasPlaten: true, // Has a flatbed - hasDuplex: false // Can do automatic duplex scanning - }] + protocol: "http", + host: "ip or hostname", + port: 80, + rs: "eSCL", + uuid: "1234etc", + icon: "http://hostname/icon.png", // Icon supplied by the scanner to represent itself visually to the user. + name: "ScanTron 9000", + note: "", // Whatever is set as the scanner's human-readable location in its settings + hasAdf: true, // Has an automatic document/page feeder + hasPlaten: true, // Has a flatbed + hasDuplex: false // Can do automatic duplex scanning +}] ``` @@ -42,5 +44,17 @@ Scan a document to PDF. Supports eSCL/AirPrint. | Param | Type | Description | | --- | --- | --- | | scannerObj | Object | A scanner object from discoverScanners() | -| opts | Object | Scanning options: dpi?: number, // default 300 colorMode?: string, // "RGB24" | "Grayscale8" | "BlackAndWhite1", default "RGB24" source?: string, // Where the document is physically located: "Platen" or "Feeder". Default is "Feeder" (if scanner has one and it isn't empty) or unset (so scanner can autodetect media). intent?: string, // default is unset. "Document" | "TextAndGraphic" | "Photo" | "Preview" duplex?: boolean, // default true if the scanner supports it. scanHeight?: number, // Height in inches. Default 11. scanWidth?: number // Width in inches. Default 8.5. | +| opts | Object | Scanning options | +**Example** +```js +var pdfBlob = await global.apis.documentscanner.scanToPDF(await discoverScanners()[0], { + dpi?: number, // default 300 + colorMode?: string, // "RGB24" | "Grayscale8" | "BlackAndWhite1", default "RGB24" + source?: string, // Where the document is physically located: "Platen" or "Feeder". Default is "Feeder" (if scanner has one and it isn't empty) or unset (so scanner can autodetect media). + intent?: string, // default is unset. "Document" | "TextAndGraphic" | "Photo" | "Preview" + duplex?: boolean, // default true if the scanner supports it. + scanHeight?: number, // Height in inches. Default 11. + scanWidth?: number // Width in inches. Default 8.5. +}); +```