A job that can be used to insert pages of multiple PDF files into a base PDF file.

For more complex use cases, refer the CombinePDFJob.

Example

Sample Usage:

        const baseReadStream = fs.createReadStream("<SOURCE_PATH>");
const readStreamToInsert = fs.createReadStream("<SOURCE_PATH>");

const credentials = new ServicePrincipalCredentials({
clientId: process.env.PDF_SERVICES_CLIENT_ID,
clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
});

const pdfServices = new PDFServices({credentials});

const [baseAsset, assetToInsert] = await pdfServices.uploadAssets({
streamAssets: [{
readStream: baseReadStream,
mimeType: MimeType.PDF
}, {
readStream: readStreamToInsert,
mimeType: MimeType.PDF
}]
});

const params = new InsertPagesParams(baseAsset)
.addPagesToInsertAt({
inputAsset: assetToInsert,
basePage: 1
});

const job = new InsertPagesJob({params});

const pollingURL = await pdfServices.submit({job});

const pdfServicesResponse = await pdfServices.getJobResult({
pollingURL,
resultType: InsertPagesResult
});

const resultAsset = pdfServicesResponse.result.asset;
const streamAsset = await pdfServices.getContent({asset: resultAsset});

Hierarchy (view full)

Constructors

  • Constructs a new InsertPagesJob instance.

    Parameters

    • params: {
          outputAsset?: Asset;
          params: InsertPagesParams;
      }

      The parameters for constructing an instance of InsertPagesJob.

    Returns InsertPagesJob

    Remarks

    External assets can be set as output only when input is external asset as well.

Properties

_insertPagesParams: InsertPagesParams
_outputAsset?: Asset

Methods

  • Parameters

    Returns PDFServicesApiRequest

  • Parameters

    • baseAsset: Asset
    • assetsToInsert: Map<number, CombinePDFJobInput[]>

    Returns CombinePDFParams

  • Parameters

    • executionContext: ExecutionContext

    Returns void

Generated using TypeDoc