@adobe/pdfservices-node-sdk/lib/pdfjobs/params/ocr/OCRParams.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.OCRParams = void 0;
const ValidationUtil_1 = require("../../../internal/util/ValidationUtil");
/**
 * Parameters for converting PDF to a searchable PDF using {@link OCRJob}.
 */
class OCRParams {
    /**
     * 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) {
        ValidationUtil_1.ValidationUtil.validateOCRParams(params);
        this._ocrLocale = params.ocrLocale;
        this._ocrType = params.ocrType;
    }
    /** Returns the locale to be used for OCR.
     *
     * @returns The locale used for OCR.
     */
    get ocrLocale() {
        return this._ocrLocale;
    }
    /** Returns the type of OCR.
     *
     * @returns The type of OCR.
     */
    get ocrType() {
        return this._ocrType;
    }
}
exports.OCRParams = OCRParams;
//# sourceMappingURL=OCRParams.js.map