Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions types/html-pdf-node/html-pdf-node-tests.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { generatePdf, generatePdfs } from "html-pdf-node/index";

// $ExpectType void
// $ExpectType Promise<Buffer> || Promise<Buffer<ArrayBufferLike>>
generatePdf(
{
content: "<h1>Hello World!</h1>",
Expand All @@ -15,22 +15,50 @@ generatePdf(
},
);

// $ExpectType void
// $ExpectType Promise<Buffer> || Promise<Buffer<ArrayBufferLike>>
generatePdf({
content: "<h1>Hello World!</h1>",
});

generatePdf({
content: "<h1>Hello World!</h1>",
}).then(buffer => {
// $ExpectType Buffer || Buffer<ArrayBufferLike>
buffer;
});

// $ExpectType Promise<PdfOutput<{ content: string; name: string; }>[]>
generatePdfs(
[
{
content: "<h1>Hello World!</h1>",
name: "first.pdf",
},
{
content: "<h1>Hello World!</h1>",
name: "second.pdf",
},
],
{
format: "A4",
printBackground: true,
},
(err, buffer) => {
(err, output) => {
// $ExpectType Buffer || Buffer<ArrayBufferLike>
buffer;
output[0].buffer;
// $ExpectType string
output[0].name;
},
);

generatePdfs([
{
content: "<h1>Hello World!</h1>",
name: "first.pdf",
},
]).then(output => {
// $ExpectType Buffer || Buffer<ArrayBufferLike>
output[0].buffer;
// $ExpectType string
output[0].name;
});
12 changes: 7 additions & 5 deletions types/html-pdf-node/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,16 @@ export interface Options {
preferCSSPageSize?: boolean | undefined;
}

export type PdfOutput<T extends File = File> = Omit<T, "content"> & { buffer: Buffer };

export function generatePdf(
file: File,
options?: Options,
callback?: (err: Error, buffer: Buffer) => void,
): void;
): Promise<Buffer>;

export function generatePdfs(
files: File[],
export function generatePdfs<T extends File>(
files: T[],
options?: Options,
callback?: (err: Error, buffer: Buffer) => void,
): void;
callback?: (err: Error, output: Array<PdfOutput<T>>) => void,
): Promise<Array<PdfOutput<T>>>;