Merge pull request #39 from robertknight/typedoc

Ensure all types used in public APIs are exported, add command to build API docs

Makefile

@@ -38,6 +38,10 @@ checkformat:
 typecheck:
 	node_modules/.bin/tsc
 
+.PHONY: api-docs
+api-docs:
+	node_modules/.bin/typedoc --excludePrivate --out docs/api/ src/index.ts
+
 .PHONY: test
 test: third_party/tessdata_fast
 	node_modules/.bin/mocha

package.json

@@ -32,6 +32,7 @@
     "prettier": "^2.6.2",
     "rollup": "^2.73.0",
     "sharp": "^0.30.4",
+    "typedoc": "^0.22.17",
     "typescript": "^4.6.4"
   },
   "dependencies": {

src/index.ts

@@ -1,3 +1,16 @@
 export { OCRClient } from "./ocr-client";
+
+export type { OCRClientInit } from "./ocr-client";
+
 export { createOCREngine, layoutFlags, supportsFastBuild } from "./ocr-engine";
-export type { BoxItem, Orientation, TextItem, TextUnit } from "./ocr-engine";
+
+export type {
+  CreateOCREngineOptions,
+  BoxItem,
+  IntRect,
+  OCREngine,
+  Orientation,
+  ProgressListener,
+  TextItem,
+  TextUnit,
+} from "./ocr-engine";

src/ocr-client.ts

@@ -1,6 +1,12 @@
 import * as comlink from "comlink";
 
-import type { BoxItem, Orientation, TextItem, TextUnit } from "./ocr-engine";
+import type {
+  BoxItem,
+  Orientation,
+  ProgressListener,
+  TextItem,
+  TextUnit,
+} from "./ocr-engine";
 
 // Although this import is Node-specific, it is tiny and doesn't import any
 // Node libs, so can be included in a bundle that runs in non-Node environments.
@@ -18,8 +24,6 @@ function createWebWorker(url: string) {
   return new Worker(url);
 }
 
-type ProgressListener = (progress: number) => void;
-
 export type OCRClientInit = {
   /**
    * Callback that creates the worker. The default implementation creates a Web Worker.
@@ -213,11 +217,11 @@ export class OCRClient {
     return engine.getOrientation();
   }
 
-  _addProgressListener(listener: ProgressListener) {
+  private _addProgressListener(listener: ProgressListener) {
     this._progressListeners.push(listener);
   }
 
-  _removeProgressListener(listener: ProgressListener) {
+  private _removeProgressListener(listener: ProgressListener) {
     this._progressListeners = this._progressListeners.filter(
       (l) => l !== listener
     );