Zum Hauptinhalt springen

Xtractor

Type Parameters​

ImportDataT​

ImportDataT

DocumentT​

DocumentT extends XtractTransformResult

Methods​

export()​

export(options): void

Parameters​

options​

XtractorExportOptions

Returns​

void


import()​

import(options): ImportDataT

Parameters​

options​

XtractorImportOptions

Returns​

ImportDataT


hasDocumentsIntegratedValidation()​

hasDocumentsIntegratedValidation(): boolean

Returns​

boolean


shouldSkipImport()​

shouldSkipImport(): boolean

Returns​

boolean


canProceedAfterXtract()​

canProceedAfterXtract(options): boolean

Parameters​

options​

XtractorCanProceedAfterXtractOptions

Returns​

boolean


mustValidateImportData()​

mustValidateImportData(options): void

Parameters​

options​

XtractorMustValidateImportDataOptions<ImportDataT>

Returns​

void


transformImportData()​

transformImportData(options): DocumentT[]

Parameters​

options​

XtractorTransformImportDataOptions<ImportDataT>

Returns​

DocumentT[]


beforeImport()​

beforeImport(options): void

Parameters​

options​

XtractorBeforeImportOptions

Returns​

void


afterImport()​

afterImport(options): void

Parameters​

options​

XtractorAfterImportOptions

Returns​

void


delete()​

delete(options): void

Parameters​

options​

XtractorBaseOptions

Returns​

void


getTaskInfo()​

getTaskInfo(options): XtractTaskInfo

Parameters​

options​

XtractorGetTaskInfoOptions

Returns​

XtractTaskInfo


getAllTaskInfos()​

getAllTaskInfos(): XtractTaskInfo[]

Returns​

XtractTaskInfo[]


downloadFile()​

downloadFile(options): void

Parameters​

options​

XtractorDownloadFileOptions<DocumentT>

Returns​

void


mapXtractorDataToDocFile()​

mapXtractorDataToDocFile(options): void

Parameters​

options​

XtractorMapDataToDocFileOptions

Returns​

void


clearXtractState()​

clearXtractState(options): void

Parameters​

options​

XtractorClearXtractStateOptions

Returns​

void


finishXtractionProcess()​

finishXtractionProcess(options): void

Parameters​

options​

XtractorFinishXtractionProcessOptions

Returns​

void


getXtractorType()​

getXtractorType(): string

Returns​

string