ocr-space-api-wrapper 2.4.3 → 2.4.5

package/README.md

@@ -39,6 +39,7 @@ The input param specifies the input file (see examples above). It can be _one_ o
 This param is an object with the following keys:
 - `apiKey`: your API key for [ocr.space APIs](https://ocr.space/ocrapi). Default API key has a limit of max 10reqs in 10mins.
 - `ocrUrl`: a different URL for ocr.space APIs, for example when you purchase the PRO plan.
+- `signal`: an `AbortSignal` for `AbortController` to abort the request.
 - All other params as documented in the [official website](https://ocr.space/OCRAPI#PostParameters).
 
 ## Response

package/index.d.ts

@@ -18,6 +18,7 @@ declare module "ocr-space-api-wrapper" {
     scale?: boolean;
     isTable?: boolean;
     OCREngine?: '1' | '2' | '3';
+    signal?: AbortSignal;
   };
 
   export type OcrSpaceParsedResult = {

package/index.js

@@ -28,6 +28,7 @@ async function ocrSpace(input, options = {}) {
       apiKey, ocrUrl, language, isOverlayRequired,
       filetype, detectOrientation, isCreateSearchablePdf,
       isSearchablePdfHideTextLayer, scale, isTable, OCREngine,
+      signal,
     } = options;
     const formData = new FormData();
     const detectedInput = detectInput(input);
@@ -66,6 +67,7 @@ async function ocrSpace(input, options = {}) {
       data: formData,
       maxContentLength: Infinity,
       maxBodyLength: Infinity,
+      signal,
     };
     const { data } = await axios(request);
     return data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ocr-space-api-wrapper",
-  "version": "2.4.3",
+  "version": "2.4.5",
   "description": "Node.js wrapper for ocr.space APIs.",
   "main": "index.js",
   "scripts": {
@@ -31,7 +31,7 @@
   },
   "homepage": "https://github.com/DavideViolante/ocr-space-api-wrapper#readme",
   "dependencies": {
-    "axios": "~0.30.2",
+    "axios": "~0.30.3",
     "form-data": "^4.0.3"
   },
   "devDependencies": {

package/test/test.js

@@ -76,4 +76,12 @@ describe('Tests for OCR Space API Wrapper', () => {
     assert.notStrictEqual(res1.SearchablePDFURL, 'Searchable PDF not generated as it was not requested.');
     assert.match(res1.SearchablePDFURL, /https?:\/\/.*\.pdf/);
   });
+  it('should abort the request', async () => {
+    const controller = new AbortController();
+    const { signal } = controller;
+    const promise = ocrSpace('./test/eng.png', { signal });
+    controller.abort();
+    const res1 = await promise;
+    assert.strictEqual(res1, undefined);
+  });
 });