@adobe/pdfservices-node-sdk/lib/pdfjobs/params/exportpdftoimages/ExportPDFToImagesParams.js

The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.

"use strict";
/*
 * Copyright 2024 Adobe
 * All Rights Reserved.
 *
 * NOTICE: Adobe permits you to use, modify, and distribute this file in
 * accordance with the terms of the Adobe license agreement accompanying
 * it. If you have received this file from a source other than Adobe,
 * then your use, modification, or distribution of it requires the prior
 * written permission of Adobe.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExportPDFToImagesParams = void 0;
const ValidationUtil_1 = require("../../../internal/util/ValidationUtil");
/**
 * Parameters for exporting a source PDF file to images using {@link ExportPDFToImagesJob}.
 */
class ExportPDFToImagesParams {
    /**
     * Constructs a new `ExportPDFToImagesParams` instance.
     *
     * @param params - The parameters for constructing an instance of `ExportPDFToImagesParams`.
     * @param params.outputType - The output type for the exported images. If it is set to
     * {@link ExportPDFToImagesOutputType#ZIP_OF_PAGE_IMAGES zip of page images} then the response will be provided
     * as a zip response, otherwise if set as
     * {@link ExportPDFToImagesOutputType#LIST_OF_PAGE_IMAGES list of page images} the response will be provided
     * as list of images as specified in the targetFormat. Cannot be undefined.
     * @param params.targetFormat - The target format for the exported images. Cannot be undefined.
     */
    constructor(params) {
        ValidationUtil_1.ValidationUtil.validateExportPDFToImagesParams(params);
        this._exportPDFToImagesOutputType = params.outputType;
        this._exportPDFToImagesTargetFormat = params.targetFormat;
    }
    /**
     * Returns the output type for the exported images.
     *
     * @returns The output type for the exported images.
     */
    get outputType() {
        return this._exportPDFToImagesOutputType;
    }
    /**
     * Returns the target format for the exported images.
     *
     * @returns The target format for the exported images.
     */
    get targetFormat() {
        return this._exportPDFToImagesTargetFormat;
    }
}
exports.ExportPDFToImagesParams = ExportPDFToImagesParams;
//# sourceMappingURL=ExportPDFToImagesParams.js.map