@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
35 lines (34 loc) • 1.48 kB
TypeScript
import { PDFServicesJobParams } from "../PDFServicesJobParams";
import { ExportPDFTargetFormat } from "./ExportPDFTargetFormat";
import { ExportOCRLocale } from "./ExportOCRLocale";
/**
* Parameters for exporting a source PDF file to a supported format using {@link ExportPDFJob}.
*/
export declare class ExportPDFParams implements PDFServicesJobParams {
private readonly _exportPDFTargetFormat;
private readonly _exportOcrLocale?;
/**
* Constructs a new `ExportPDFParams` instance.
*
* @param params - The parameters for constructing an instance of `ExportPDFParams`.
* @param params.targetFormat The target format to which the source PDF file will be exported. Cannot be undefined.
* @param [params.ocrLocale] The OCR language to be used for exporting the source PDF file.
* Default value is {@link ExportOCRLocale#EN_US EN_US}.
*/
constructor(params: {
targetFormat: ExportPDFTargetFormat;
ocrLocale?: ExportOCRLocale;
});
/**
* Returns the target format to which the source PDF file will be exported.
*
* @returns The target format to which the source PDF file will be exported.
*/
get exportPDFTargetFormat(): ExportPDFTargetFormat;
/**
* Returns the OCR language to be used for exporting the source PDF file.
*
* @returns The OCR language to be used for exporting the source PDF file.
*/
get exportOcrLocale(): ExportOCRLocale | undefined;
}