🤖 Merge PR #53794 update(word-extractor): v1 update by @peterblazejewicz

- new methods added
- version bump
- tests amended

morungos/node-word-extractor@0.3.0...1.0.2

Thanks!

types/word-extractor/index.d.ts

@@ -1,10 +1,10 @@
-// Type definitions for word-extractor 0.3
+// Type definitions for word-extractor 1.0
 // Project: https://github.com/morungos/node-word-extractor
 // Definitions by: Rodrigo Saboya <https://github.com/saboya>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 declare class WordExtractor {
-    extract(documentPath: string): Promise<WordExtractor.Document>;
+    extract(documentPath: string | Uint8Array): Promise<WordExtractor.Document>;
 }
 
 export = WordExtractor;
@@ -13,8 +13,10 @@ declare namespace WordExtractor {
     class Document {
         getBody(): string;
         getFootnotes(): string;
-        getHeaders(): string;
+        getHeaders(options?: { includeFooters?: boolean }): string;
+        getFooters(): string;
         getAnnotations(): string;
+        getTextboxes(options?: { includeHeadersAndFooters?: boolean; includeBody?: boolean }): string;
         getEndNotes(): string;
     }
 }

types/word-extractor/word-extractor-tests.ts

@@ -1,13 +1,22 @@
-import WordExtractor = require("word-extractor");
+import WordExtractor = require('word-extractor');
 
 const extractor = new WordExtractor();
 
-let temp: string;
-
-const doc = extractor.extract('/path/to/file.doc').then(document => {
-    temp = document.getBody();
-    temp = document.getAnnotations();
-    temp = document.getEndNotes();
-    temp = document.getFootnotes();
-    temp = document.getHeaders();
+extractor.extract('/path/to/file.doc').then(document => {
+    document.getBody(); // $ExpectType string
+    document.getAnnotations(); // $ExpectType string
+    document.getEndNotes(); // $ExpectType string
+    document.getFootnotes(); // $ExpectType string
+    document.getHeaders(); // $ExpectType string
+    document.getHeaders(); // $ExpectType string
+    // $ExpectType string
+    document.getHeaders({
+        includeFooters: false,
+    });
+    document.getFooters(); // $ExpectType string
+    // $ExpectType string
+    document.getTextboxes({
+        includeBody: false,
+        includeHeadersAndFooters: false,
+    });
 });