Skip to content

fix(wktohtml): fix callback and return types #69493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 5 commits into from
May 2, 2024
Merged

fix(wktohtml): fix callback and return types #69493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9f9760
fix(wkhtmltopdf): fix callback type
marievidal360 May 1, 2024
f0ed20a
fix(wkhtmltopdf): add optional callback in inputStream case
marievidal360 May 1, 2024
ad5c93a
fix(wkhtmltopdf): fix return type
marievidal360 May 1, 2024
0273f5b
refactor(wkhtmltopdf): move $ExpectType before tested expression
marievidal360 May 1, 2024
9047c9c
refactor(wkhtmltopdf): formatting
marievidal360 May 1, 2024
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
16 changes: 11 additions & 5 deletions types/wkhtmltopdf/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

/// <reference types="node"/>

import { Readable } from "stream";

/**
* Call wkhtmltopdf and write PDF
* If options.output is defined the file will be returned in the stream
Expand All @@ -13,8 +15,8 @@
declare function wkhtmltopdf(
html: string,
options?: Options,
callback?: (err: Error, stream: NodeJS.ReadWriteStream) => void,
): NodeJS.ReadWriteStream;
callback?: (err: Error | null, stream?: NodeJS.ReadWriteStream) => void,
): Readable;
/**
* Call wkhtmltopdf and write PDF
* If options.output is defined the file will be returned in the stream
Expand All @@ -26,8 +28,8 @@ declare function wkhtmltopdf(
declare function wkhtmltopdf(
url: string,
options?: Options,
callback?: (err: Error, stream: NodeJS.ReadWriteStream) => void,
): NodeJS.ReadWriteStream;
callback?: (err: Error | null, stream?: NodeJS.ReadWriteStream) => void,
): Readable;
/**
* Call wkhtmltopdf and write PDF
* If options.output is defined the file will be returned in the stream
Expand All @@ -36,7 +38,11 @@ declare function wkhtmltopdf(
* @param [options] Options
* @param [callback] Callback
*/
declare function wkhtmltopdf(inputStream: NodeJS.ReadStream, options?: Options): NodeJS.ReadWriteStream;
declare function wkhtmltopdf(
inputStream: NodeJS.ReadStream,
options?: Options,
callback?: (err: Error | null, stream?: NodeJS.ReadWriteStream) => void,
): Readable;

declare namespace wkhtmltopdf {
/**
Expand Down
30 changes: 20 additions & 10 deletions types/wkhtmltopdf/wkhtmltopdf-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
import wkhtmltopdf = require("wkhtmltopdf");

// URL
wkhtmltopdf("http://google.com/", { pageSize: "Letter" }); // $ExpectType NodeJS.ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://google.com/", { pageSize: "Letter" });

// HTML
wkhtmltopdf("<h1>Test</h1><p>Hello world</p>"); // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("<h1>Test</h1><p>Hello world</p>");

// output to a file directly
wkhtmltopdf("http://apple.com/", { output: "out.pdf" }); // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", { output: "out.pdf" });

// Optional callback
wkhtmltopdf("http://google.com/", { pageSize: "Letter" }, (err: Error, stream: NodeJS.ReadWriteStream) => {}); // $ExpectType void
// $ExpectType Readable
wkhtmltopdf("http://google.com/", { pageSize: "Letter" }, (err: Error | null, stream?: NodeJS.ReadWriteStream) => {});

// Repeatable options
wkhtmltopdf("http://google.com/", { // $ExpectType NodeJS.ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://google.com/", {
allow: ["path1", "path2"],
customHeader: [
["name1", "value1"],
Expand All @@ -22,23 +27,27 @@ wkhtmltopdf("http://google.com/", { // $ExpectType NodeJS.ReadWriteStream
});

// Ignore warning strings
wkhtmltopdf("http://apple.com/", { // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", {
output: "out.pdf",
ignore: ["QFont::setPixelSize: Pixel size <= 0 (0)"],
});

// RegExp also acceptable
wkhtmltopdf("http://apple.com/", { // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", {
output: "out.pdf",
ignore: [/QFont::setPixelSize/],
});

// Test debug types
wkhtmltopdf("http://apple.com/", { // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", {
debug: true,
});

wkhtmltopdf("http://apple.com/", { // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", {
output: "test.pdf",
debug: (data: Buffer) => {
const dataString = data.toString();
Expand All @@ -56,7 +65,8 @@ wkhtmltopdf.shell; // $ExpectType string
wkhtmltopdf.command; // $ExpectType string

// Footer and header spacing type
wkhtmltopdf("http://apple.com/", { // $ExpectType ReadWriteStream
// $ExpectType Readable
wkhtmltopdf("http://apple.com/", {
headerSpacing: 0,
footerSpacing: 0,
});