@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
34 lines (33 loc) • 1.21 kB
TypeScript
import { PDFServicesJobParams } from "../PDFServicesJobParams";
import { OCRSupportedLocale } from "./OCRSupportedLocale";
import { OCRSupportedType } from "./OCRSupportedType";
/**
* Parameters for converting PDF to a searchable PDF using {@link OCRJob}.
*/
export declare class OCRParams implements PDFServicesJobParams {
private readonly _ocrLocale?;
private readonly _ocrType?;
/**
* Constructs a new `OCRParams` instance.
*
* @param params The parameters for constructing an `OCRParams` instance.
* @param [params.ocrLocale] The input language to be used for OCR. Default value is
* {@link OCRSupportedLocale#EN_US EN_US}.
* @param [params.ocrType] The type of OCR. Default value is
* {@link OCRSupportedType#SEARCHABLE_IMAGE SEARCHABLE_IMAGE}.
*/
constructor(params: {
ocrLocale?: OCRSupportedLocale;
ocrType?: OCRSupportedType;
});
/** Returns the locale to be used for OCR.
*
* @returns The locale used for OCR.
*/
get ocrLocale(): OCRSupportedLocale | undefined;
/** Returns the type of OCR.
*
* @returns The type of OCR.
*/
get ocrType(): OCRSupportedType | undefined;
}