Class WordExtractor

Reads text out of a Word document. .docx only: mammoth cannot read the binary .doc format.

Hierarchy (View Summary)

BaseContentExtractor
- WordExtractor

Index

Constructors

Properties

Key SupportedFileTypes

Methods

Extract Supports Resolve

Constructors

constructor

new WordExtractor(): WordExtractor
Returns WordExtractor
Inherited from BaseContentExtractor.constructor

Properties

`Readonly`Key

Key: "Word" = WORD_EXTRACTOR

The registration key. Must match the key passed to @RegisterClass.

`Readonly`SupportedFileTypes

SupportedFileTypes: string[] = ...

The file types this extractor handles. '*' means any; only the built-in fallback should use it.

Methods

Extract

Extract(request: ExtractRequest): Promise<ExtractResult>
Read the bytes.
Parameters
- request: ExtractRequest
Returns Promise<ExtractResult>
Overrides BaseContentExtractor.Extract
- Defined in ContentPipeline/engine/src/extractors/DocumentExtractor.ts:43

Supports

Supports(fileType: string): boolean
Whether this extractor handles a given file type.
Parameters
- fileType: string
Returns boolean
Inherited from BaseContentExtractor.Supports
- Defined in ContentPipeline/base/dist/extract/BaseContentExtractor.d.ts:94

`Static`Resolve

Resolve(key: string): BaseContentExtractor
Resolve a registered extractor by key, returning null rather than a hollow base instance.
Parameters
- key: string
Returns BaseContentExtractor
Inherited from BaseContentExtractor.Resolve
- Defined in ContentPipeline/base/dist/extract/BaseContentExtractor.d.ts:96