Class OCRParams

Parameters for converting PDF to a searchable PDF using OCRJob.

Implements

PDFServicesJobParams

Index

Constructors

Properties

_ocrLocale? _ocrType?

Accessors

ocrLocale ocrType

Constructors

constructor

new OCRParams(params): OCRParams
Constructs a new OCRParams instance.
Parameters
- params: {
  ocrLocale?: OCRSupportedLocale;
  ocrType?: OCRSupportedType;
  }
  The parameters for constructing an OCRParams instance.
  - Optional ocrLocale?: OCRSupportedLocale
    The input language to be used for OCR. Default value is EN_US.
  - Optional ocrType?: OCRSupportedType
    The type of OCR. Default value is SEARCHABLE_IMAGE.
Returns OCRParams
- Defined in src/pdfjobs/params/ocr/OCRParams.ts:33

Properties

`Private` `Optional` `Readonly` _ocrLocale

_ocrLocale?: OCRSupportedLocale

`Private` `Optional` `Readonly` _ocrType

_ocrType?: OCRSupportedType

Accessors

ocrLocale

get ocrLocale(): undefined | OCRSupportedLocale
Returns the locale to be used for OCR.

Returns undefined | OCRSupportedLocale
The locale used for OCR.
- Defined in src/pdfjobs/params/ocr/OCRParams.ts:43

ocrType

get ocrType(): undefined | OCRSupportedType
Returns the type of OCR.

Returns undefined | OCRSupportedType
The type of OCR.
- Defined in src/pdfjobs/params/ocr/OCRParams.ts:51

Generated using TypeDoc