Accessors version get version( ) : string Returns string Methods begin Pdf begin Pdf ( options ) : Promise < PdfGenerator > Parameters options : DeepPartial<PdfConfiguration>begin Tiff begin Tiff ( options ? ) : Promise < TiffGenerator > Parameters Optional
options : DeepPartial<TiffGeneratorParameters>create Document Data Extractor create Document Data Extractor ( options ) : Promise < DocumentDataExtractor > Parameters options : DeepPartial<DocumentDataExtractorConfiguration>create Document Data Extractor Scanner create Document Data Extractor Scanner ( config ) : Promise < any > Returns Promise < any > create Document Quality Analyzer create Document Quality Analyzer ( config ? ) : Promise < DocumentQualityAnalyzer > Parameters Optional
config : DeepPartial<DocumentQualityAnalyzerConfiguration>create SimpleMRZRecognizer destroy destroy ( ) : void Returns void detect Barcodes detect Barcodes ( image , partialDetectionParameters ? , consumeImage ? ) : Promise < BarcodeScannerResult & { originalImage : Image ; } > Parameters image : string | Image Optional
partialDetectionParameters : { barcodeFormatConfigurations ?: ( ( { readonly _type?: "BarcodeFormatCodabarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; returnStartEnd?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode11Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksum?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode39Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 8 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode93Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode128Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode2Of5Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 6 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarExpandedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarLimitedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatITFConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMSIPlesseyConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksumAlgorithms?: MsiPlesseyChecksumAlgorithm[]; _marke...) | ( { readonly _type?: "BarcodeFormatUpcEanConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPharmaCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumValue?: number; allowNarrowBarsOnly?: boolean; allowWideBarsOnly?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatAztecConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatQRCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; qr?: boolean; microQr?: boolean; rmqr?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMicroPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataMatrixConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMaxiCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatAustraliaPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; australiaPostCustomerFormat?: AustraliaPostCustomerFormat; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatJapanPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatRoyalMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; stripCheckDigits?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatRoyalTNTPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatUSPSIntelligentMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPharmaCodeTwoTrackConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimumValue?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatGS1CompositeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonOneDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 4 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonTwoDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonFourStateConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) ) [] ; engineMode ?: BarcodeScannerEngineMode ; extractedDocumentFormats ?: BarcodeDocumentFormat [] ; onlyAcceptDocuments ?: boolean ; returnBarcodeImage ?: boolean ; } Optional
barcode Format Configurations ?: ( ( { readonly _type?: "BarcodeFormatCodabarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; returnStartEnd?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode11Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksum?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode39Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 8 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode93Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode128Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCode2Of5Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 6 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarExpandedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataBarLimitedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatITFConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMSIPlesseyConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksumAlgorithms?: MsiPlesseyChecksumAlgorithm[]; _marke...) | ( { readonly _type?: "BarcodeFormatUpcEanConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPharmaCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumValue?: number; allowNarrowBarsOnly?: boolean; allowWideBarsOnly?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatAztecConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatQRCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; qr?: boolean; microQr?: boolean; rmqr?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMicroPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatDataMatrixConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatMaxiCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatAustraliaPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; australiaPostCustomerFormat?: AustraliaPostCustomerFormat; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatJapanPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatRoyalMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; stripCheckDigits?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatRoyalTNTPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatUSPSIntelligentMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatPharmaCodeTwoTrackConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimumValue?: number; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatGS1CompositeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonOneDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 4 more ...; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonTwoDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonFourStateConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ( { readonly _type?: "BarcodeFormatCommonConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) ) [] Optional
only Accept Documents ?: boolean Optional
return Barcode Image ?: boolean Optional
consumeImage : ConsumeType detect Document detect Document ( image , detectionParameters ? , consumeImage ? ) : Promise < DocumentDetectionResult > Parameters Optional
detectionParameters : DeepPartial<DocumentScannerParameters>Optional
consumeImage : ConsumeType image Crop image Crop ( image , polygon , consumeImage ? ) : Promise < RawImage > Returns Promise < RawImage > image Filter image Filter ( image , filter , consumeImage ? ) : Promise < RawImage > Returns Promise < RawImage > image Resize image Resize ( image , destinationSize , consumeImage ? ) : Promise < RawImage > Parameters destinationSize : number Optional
consumeImage : ConsumeType Returns Promise < RawImage > image Rotate image Rotate ( image , rotation , consumeImage ? ) : Promise < RawImage > Returns Promise < RawImage > image To Jpeg image To Jpeg ( image , consumeImage ? ) : Promise < Uint8Array > Returns Promise < Uint8Array > parse Barcode Document parse Barcode Document ( acceptedDocumentFormats , rawBarcodeData ) : Promise < GenericDocument > release release ( object , source ? ) : Promise < void > Returns Promise < void > to Data Url to Data Url ( imageBuffer ) : Promise < string > Returns Promise < string >
PdfConfiguration