Skip to content

Improve types #887

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

Open
konradliebig wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve types #887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
94 changes: 50 additions & 44 deletions type.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,55 @@
declare module "html2pdf.js" {
interface Html2PdfOptions {
margin?: number | [number, number] | [number, number, number, number];
filename?: string;
image?: {
type?: "jpeg" | "png" | "webp";
quality?: number;
};
enableLinks?: boolean;
html2canvas?: object;
jsPDF?: {
unit?: string;
format?: string | [number, number];
orientation?: "portrait" | "landscape";
};
}
export type PageBreakMode = "avoid-all" | "css" | "legacy";

interface Html2PdfWorker {
from(src: HTMLElement | string | HTMLCanvasElement | HTMLImageElement): this;
to(target: "container" | "canvas" | "img" | "pdf"): this;
toContainer(): this;
toCanvas(): this;
toImg(): this;
toPdf(): this;
output(type?: string, options?: any, src?: "pdf" | "img"): Promise<any>;
outputPdf(type?: string, options?: any): Promise<any>;
outputImg(type?: string, options?: any): Promise<any>;
save(filename?: string): Promise<void>;
set(options: Html2PdfOptions): this;
get(key: string, cbk?: (value: any) => void): Promise<any>;
then<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
thenCore<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
thenExternal<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
catch<T>(onRejected?: (reason: any) => T | PromiseLike<T>): Promise<T>;
catchExternal<T>(onRejected?: (reason: any) => T | PromiseLike<T>): Promise<T>;
error(msg: string): void;
export interface Html2PdfOptions {
margin?: number | [number, number] | [number, number, number, number];
filename?: string;
pagebreak?: {
mode?: PageBreakMode | PageBreakMode[];
before?: string | string[];
after?: string | string[];
avoid?: string | string[];
}
image?: {
type?: "jpeg" | "png" | "webp";
quality?: number;
};
enableLinks?: boolean;
html2canvas?: object;
jsPDF?: {
unit?: string;
format?: string | [number, number];
orientation?: "portrait" | "landscape";
};
}

interface Html2PdfStatic {
(): Html2PdfWorker;
new (): Html2PdfWorker;
(element: HTMLElement, options?: Html2PdfOptions): Promise<void>;
new (element: HTMLElement, options?: Html2PdfOptions): Promise<void>;
Worker: new () => Html2PdfWorker;
}
export interface Html2PdfWorker {
from(src: HTMLElement | string | HTMLCanvasElement | HTMLImageElement): this;
to(target: "container" | "canvas" | "img" | "pdf"): this;
toContainer(): this;
toCanvas(): this;
toImg(): this;
toPdf(): this;
output(type?: string, options?: any, src?: "pdf" | "img"): Promise<any>;
outputPdf(type?: string, options?: any): Promise<any>;
outputImg(type?: string, options?: any): Promise<any>;
save(filename?: string): Promise<void>;
set(options: Html2PdfOptions): this;
get(key: string, cbk?: (value: any) => void): Promise<any>;
then<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
thenCore<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
thenExternal<T>(onFulfilled?: (value: any) => T | PromiseLike<T>, onRejected?: (reason: any) => any): Promise<T>;
catch<T>(onRejected?: (reason: any) => T | PromiseLike<T>): Promise<T>;
catchExternal<T>(onRejected?: (reason: any) => T | PromiseLike<T>): Promise<T>;
error(msg: string): void;
}

const html2pdf: Html2PdfStatic;
export default html2pdf;
interface Html2PdfStatic {
(): Html2PdfWorker;
new (): Html2PdfWorker;
(element: HTMLElement, options?: Html2PdfOptions): Promise<void>;
new (element: HTMLElement, options?: Html2PdfOptions): Promise<void>;
Worker: new () => Html2PdfWorker;
}

const html2pdf: Html2PdfStatic;
export default html2pdf;