@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
43 lines (42 loc) • 1.48 kB
TypeScript
import { PDFServicesJobParams } from "../PDFServicesJobParams";
import { PageRanges } from "../PageRanges";
/**
* Parameters for splitting a PDF using {@link SplitPDFJob}.
*/
export declare class SplitPDFParams implements PDFServicesJobParams {
private readonly _pageRanges?;
private readonly _pageCount?;
private readonly _fileCount?;
/**
* Constructs a new `SplitPDFParams` instance.
*
* @param params - The parameters for constructing a `SplitPDFParams` instance. One of `pageRanges`, `pageCount`
* or `fileCount` is required.
* @param [params.pageRanges] - The page ranges to be used for splitting pages.
* @param [params.pageCount] - The maximum number of pages each of the output files can have.
* @param [params.fileCount] - The number of documents to split the input PDF file into.
*/
constructor(params: {
pageRanges?: PageRanges;
pageCount?: number;
fileCount?: number;
});
/**
* Returns the page ranges to be used for splitting pages.
*
* @returns The page ranges.
*/
get pageRanges(): PageRanges | undefined;
/**
* Returns the maximum number of pages each of the output files can have.
*
* @returns The page count.
*/
get pageCount(): number | undefined;
/**
* Returns the number of documents to split the input PDF file into.
*
* @returns The file count.
*/
get fileCount(): number | undefined;
}