Replace static output file mask with a custom naming function

__tests__/output.file.mask.buffer.test.ts

@@ -0,0 +1,25 @@
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { expect, test } from 'vitest';
+import { PngPageOutput, pdfToPng } from '../src';
+
+const pdfFilePath: string = resolve('./test-data/large_pdf.pdf');
+const pdfBuffer: Buffer = readFileSync(pdfFilePath);
+
+test(`should apply file mask is defined for pdf buffer`, async () => {
+ const pngPages: PngPageOutput[] = await pdfToPng(pdfBuffer, {
+ outputFileMaskFunc: (pageNumber: number) => `custom_buffer_${pageNumber}.png`,
+ });
+
+ pngPages.forEach((pngPage: PngPageOutput, index: number) => {
+ expect(pngPage.name).to.equal(`custom_buffer_${index + 1}.png`);
+ });
+});
+
+test(`should apply default buffer name if outputFileMaskFunc is not defined for pdf buffer`, async () => {
+ const pngPages: PngPageOutput[] = await pdfToPng(pdfBuffer);
+
+ pngPages.forEach((pngPage: PngPageOutput, index: number) => {
+ expect(pngPage.name).to.equal(`buffer_page_${index + 1}.png`);
+ });
+});

__tests__/output.file.mask.file.test.ts

@@ -0,0 +1,23 @@
+import { parse, resolve } from 'node:path';
+import { expect, test } from 'vitest';
+import { PngPageOutput, pdfToPng } from '../src';
+
+const pdfFilePath: string = resolve('./test-data/large_pdf.pdf');
+
+test(`should apply file mask if defined for pdf file path`, async () => {
+ const pngPages: PngPageOutput[] = await pdfToPng(pdfFilePath, {
+ outputFileMaskFunc: (pageNumber: number) => `pdf_file_${pageNumber}.png`,
+ });
+
+ pngPages.forEach((pngPage: PngPageOutput, index: number) => {
+ expect(pngPage.name).to.equal(`pdf_file_${index + 1}.png`);
+ });
+});
+
+test(`should apply default buffer name if outputFileMaskFunc is not defined for pdf buffer`, async () => {
+ const pngPages: PngPageOutput[] = await pdfToPng(pdfFilePath);
+
+ pngPages.forEach((pngPage: PngPageOutput, index: number) => {
+ expect(pngPage.name).to.equal(`${parse(pdfFilePath).name}_page_${index + 1}.png`);
+ });
+});

__tests__/props.to.pdf.doc.init.params.test.ts

@@ -141,7 +141,6 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
  enableXfa: true,
  pdfFilePassword: 'pdfFilePassword',
  outputFolder: 'outputFolder',
- outputFileMask: 'outputFileMask',
  pagesToProcess: [1, 2, 3],
  strictPagesToProcess: true,
  verbosityLevel: 2,