Constructors
constructor
- new SDKWorkerBridge(path, options, initializeArgs): SDKWorkerBridge
Parameters
path: string
initializeArgs: [licenseKey?: string, enginePath?: string, appId?: string, options?: InitializeOptions]
Properties
Readonly copyArgs
copyArgs: { BarcodeDocumentParser: WorkerBarcodeDocumentParser; BarcodeScanner: WorkerBarcodeScanner; CheckScanner: WorkerCheckScanner; CreditCardScanner: WorkerCreditCardScanner; DocumentClassifier: WorkerDocumentClassifier; DocumentDataExtractor: WorkerDocumentDataExtractor; DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer; DocumentScanner: WorkerDocumentScanner; ImageManipulator: WorkerImageManipulator; ImageProcessor: WorkerImageProcessor; MrzParser: WorkerMrzParser; MrzScanner: WorkerMrzScanner; OcrEngine: WorkerOcrEngine; TextPatternScanner: WorkerTextPatternScanner; VinScanner: WorkerVinScanner; __callModuleFunction: ((functionName,
args?) => Promise<any>); __hasModuleFunction: ((functionName) => Promise<any>); addPageToPdf: ((pdfOperation,
image,
binarization?) => Promise<void>); addPageToPdfWithOcr: ((pdfOperation,
image,
binarization?) => Promise<void>); addPageToTiff: ((tiffOperation,
image,
binarization) => Promise<void>); beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>); beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>); completePdf: ((pdfOperation) => Promise<Uint8Array>); completeTiff: ((tiffOperation) => Promise<Uint8Array>); encodeJpeg: ((image,
quality?) => Promise<Uint8Array>); getLicenseInfo: (() => Promise<LicenseInfo>); initialize: ((licenseKey?,
enginePath?,
appId?,
options?) => Promise<void>); releaseObject: (<T>(objectToken) => Promise<void>); version: (() => Promise<string>); } Type declaration
__callModuleFunction: ((functionName, args?) => Promise<any>)
- (functionName, args?): Promise<any>
Parameters
functionName: string
Optional args: any[]
Returns Promise<any>
__hasModuleFunction: ((functionName) => Promise<any>)
- (functionName): Promise<any>
Returns Promise<any>
addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>)
- (pdfOperation, image, binarization?): Promise<void>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<void>
addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>)
- (pdfOperation, image, binarization?): Promise<void>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<void>
addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>)
- (tiffOperation, image, binarization): Promise<void>
Parameters
tiffOperation: ObjectId<"TiffGenerationContext">
Returns Promise<void>
beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>)
- (options): Promise<ObjectId<"PdfGenerationContext">>
Parameters
options: {
attributes?: {
author?: string;
creator?: string;
keywords?: string;
subject?: string;
title?: string;
};
binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
};
dpi?: number;
jpegQuality?: number;
pageDirection?: PageDirection;
pageFit?: PageFit;
pageSize?: PageSize;
resamplingMethod?: ResamplingMethod;
}
Optional attributes?: {
author?: string;
creator?: string;
keywords?: string;
subject?: string;
title?: string;
}
Optional author?: string
Optional creator?: string
Optional keywords?: string
Optional subject?: string
Optional title?: string
Optional binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
}
Optional dpi?: number
Optional jpegQuality?: number
Optional pageFit?: PageFit
Optional pageSize?: PageSize
Returns Promise<ObjectId<"PdfGenerationContext">>
beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>)
- (options): Promise<ObjectId<"TiffGenerationContext">>
Parameters
options: {
binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
};
compression?: CompressionMode;
dpi?: number;
jpegQuality?: number;
userFields?: {
name?: string;
tag?: number;
value?: {
value?: number;
} & {
_type: "UserFieldDoubleValue";
} | {
value?: string;
} & {
_type: "UserFieldStringValue";
} | {
value?: number;
} & {
_type: "UserFieldIntValue";
};
}[];
zipCompressionLevel?: number;
}
Optional binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
}
Optional dpi?: number
Optional jpegQuality?: number
Optional userFields?: {
name?: string;
tag?: number;
value?: {
value?: number;
} & {
_type: "UserFieldDoubleValue";
} | {
value?: string;
} & {
_type: "UserFieldStringValue";
} | {
value?: number;
} & {
_type: "UserFieldIntValue";
};
}[]
Optional zipCompressionLevel?: number
Returns Promise<ObjectId<"TiffGenerationContext">>
completePdf: ((pdfOperation) => Promise<Uint8Array>)
- (pdfOperation): Promise<Uint8Array>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<Uint8Array>
completeTiff: ((tiffOperation) => Promise<Uint8Array>)
- (tiffOperation): Promise<Uint8Array>
Parameters
tiffOperation: ObjectId<"TiffGenerationContext">
Returns Promise<Uint8Array>
encodeJpeg: ((image, quality?) => Promise<Uint8Array>)
- (image, quality?): Promise<Uint8Array>
Returns Promise<Uint8Array>
getLicenseInfo: (() => Promise<LicenseInfo>)
initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>)
- (licenseKey?, enginePath?, appId?, options?): Promise<void>
Parameters
Optional licenseKey: string
Optional enginePath: string
Optional appId: string
Returns Promise<void>
releaseObject: (<T>(objectToken) => Promise<void>)
- <T>(objectToken): Promise<void>
Returns Promise<void>
version: (() => Promise<string>)
- (): Promise<string>
Returns Promise<string>
Readonly transferArgs
transferArgs: { BarcodeDocumentParser: WorkerBarcodeDocumentParser; BarcodeScanner: WorkerBarcodeScanner; CheckScanner: WorkerCheckScanner; CreditCardScanner: WorkerCreditCardScanner; DocumentClassifier: WorkerDocumentClassifier; DocumentDataExtractor: WorkerDocumentDataExtractor; DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer; DocumentScanner: WorkerDocumentScanner; ImageManipulator: WorkerImageManipulator; ImageProcessor: WorkerImageProcessor; MrzParser: WorkerMrzParser; MrzScanner: WorkerMrzScanner; OcrEngine: WorkerOcrEngine; TextPatternScanner: WorkerTextPatternScanner; VinScanner: WorkerVinScanner; __callModuleFunction: ((functionName,
args?) => Promise<any>); __hasModuleFunction: ((functionName) => Promise<any>); addPageToPdf: ((pdfOperation,
image,
binarization?) => Promise<void>); addPageToPdfWithOcr: ((pdfOperation,
image,
binarization?) => Promise<void>); addPageToTiff: ((tiffOperation,
image,
binarization) => Promise<void>); beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>); beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>); completePdf: ((pdfOperation) => Promise<Uint8Array>); completeTiff: ((tiffOperation) => Promise<Uint8Array>); encodeJpeg: ((image,
quality?) => Promise<Uint8Array>); getLicenseInfo: (() => Promise<LicenseInfo>); initialize: ((licenseKey?,
enginePath?,
appId?,
options?) => Promise<void>); releaseObject: (<T>(objectToken) => Promise<void>); version: (() => Promise<string>); } Type declaration
__callModuleFunction: ((functionName, args?) => Promise<any>)
- (functionName, args?): Promise<any>
Parameters
functionName: string
Optional args: any[]
Returns Promise<any>
__hasModuleFunction: ((functionName) => Promise<any>)
- (functionName): Promise<any>
Returns Promise<any>
addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>)
- (pdfOperation, image, binarization?): Promise<void>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<void>
addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>)
- (pdfOperation, image, binarization?): Promise<void>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<void>
addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>)
- (tiffOperation, image, binarization): Promise<void>
Parameters
tiffOperation: ObjectId<"TiffGenerationContext">
Returns Promise<void>
beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>)
- (options): Promise<ObjectId<"PdfGenerationContext">>
Parameters
options: {
attributes?: {
author?: string;
creator?: string;
keywords?: string;
subject?: string;
title?: string;
};
binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
};
dpi?: number;
jpegQuality?: number;
pageDirection?: PageDirection;
pageFit?: PageFit;
pageSize?: PageSize;
resamplingMethod?: ResamplingMethod;
}
Optional attributes?: {
author?: string;
creator?: string;
keywords?: string;
subject?: string;
title?: string;
}
Optional author?: string
Optional creator?: string
Optional keywords?: string
Optional subject?: string
Optional title?: string
Optional binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
}
Optional dpi?: number
Optional jpegQuality?: number
Optional pageFit?: PageFit
Optional pageSize?: PageSize
Returns Promise<ObjectId<"PdfGenerationContext">>
beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>)
- (options): Promise<ObjectId<"TiffGenerationContext">>
Parameters
options: {
binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
};
compression?: CompressionMode;
dpi?: number;
jpegQuality?: number;
userFields?: {
name?: string;
tag?: number;
value?: {
value?: number;
} & {
_type: "UserFieldDoubleValue";
} | {
value?: string;
} & {
_type: "UserFieldStringValue";
} | {
value?: number;
} & {
_type: "UserFieldIntValue";
};
}[];
zipCompressionLevel?: number;
}
Optional binarizationFilter?: {
filterType?: number;
} & {
_type: "LegacyFilter";
} | {
outputMode?: OutputMode;
} & {
_type: "ScanbotBinarizationFilter";
} | {
denoise?: number;
outputMode?: OutputMode;
preset?: BinarizationFilterPreset;
radius?: number;
} & {
_type: "CustomBinarizationFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
colorEnhancement?: number;
contrastEnhancement?: number;
paperWhitening?: number;
paperWhiteningBias?: number;
radius?: number;
whiteOutliersFraction?: number;
} & {
_type: "ColorDocumentFilter";
} | {
brightness?: number;
} & {
_type: "BrightnessFilter";
} | {
contrast?: number;
} & {
_type: "ContrastFilter";
} | {
blackOutliersFraction?: number;
borderWidthFraction?: number;
whiteOutliersFraction?: number;
} & {
_type: "GrayscaleFilter";
} | {
blackPoint?: number;
whitePoint?: number;
} & {
_type: "WhiteBlackPointFilter";
}
Optional dpi?: number
Optional jpegQuality?: number
Optional userFields?: {
name?: string;
tag?: number;
value?: {
value?: number;
} & {
_type: "UserFieldDoubleValue";
} | {
value?: string;
} & {
_type: "UserFieldStringValue";
} | {
value?: number;
} & {
_type: "UserFieldIntValue";
};
}[]
Optional zipCompressionLevel?: number
Returns Promise<ObjectId<"TiffGenerationContext">>
completePdf: ((pdfOperation) => Promise<Uint8Array>)
- (pdfOperation): Promise<Uint8Array>
Parameters
pdfOperation: ObjectId<"PdfGenerationContext">
Returns Promise<Uint8Array>
completeTiff: ((tiffOperation) => Promise<Uint8Array>)
- (tiffOperation): Promise<Uint8Array>
Parameters
tiffOperation: ObjectId<"TiffGenerationContext">
Returns Promise<Uint8Array>
encodeJpeg: ((image, quality?) => Promise<Uint8Array>)
- (image, quality?): Promise<Uint8Array>
Returns Promise<Uint8Array>
getLicenseInfo: (() => Promise<LicenseInfo>)
initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>)
- (licenseKey?, enginePath?, appId?, options?): Promise<void>
Parameters
Optional licenseKey: string
Optional enginePath: string
Optional appId: string
Returns Promise<void>
releaseObject: (<T>(objectToken) => Promise<void>)
- <T>(objectToken): Promise<void>
Returns Promise<void>
version: (() => Promise<string>)
- (): Promise<string>
Returns Promise<string>
Methods
awaitInitialized
- awaitInitialized(): Promise<void>
Returns Promise<void>