Type definitions for TypeScript

[dartess]

Hi guys! How do you feel about TypeScript? There seems to be no types for your package. Would you mind including type definitions in the npm package? I could work on it.

[Emroni]

In case someone runs into this, I got it working it by doing:

// src/@types/index.d.ts
declare module 'html2pdf.js'

import * as html2pdf from 'html2pdf.js';

const element = document.getElementById('element-to-print');
html2pdf(element);

[apazureck]

Hi,

I read the documentation and this is my first draft for some more descriptive typings:

declare module 'html2pdf.js' {
  export default html2pdf;
}

declare function html2pdf(): Html2PdfWorkerRoot;
declare function html2pdf(element: Html2PdfElement, opt?: Html2PdfWorkerOptions): void;

declare type Html2PdfWorkerRoot = Html2PdfWorkerRoot;
declare type Html2PdfElement = string | HTMLElement;

declare interface Html2PdfWorkerRoot {
  from(element: Html2PdfElement, type?: 'string' | 'element' | 'canvas' | 'img'): Html2PdfWorkerFrom;
}

declare interface Html2PdfWorkerContainer extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
  toCanvas(): Html2PdfWorkerCanvas;
}

declare interface Html2PdfWorkerFrom extends Html2PdfWorkerSave, Html2PdfWorkerTarget, Html2PdfworkerOptions {
  toContainer(): Html2PdfWorkerContainer;
}

declare interface Html2PdfWorkerCanvas extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
  toImg(): Html2PdfWorkerSave;
}

declare interface Html2PdfworkerImage extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
  toPdf(): Html2PdfWorkerSave;
}

declare interface Html2PdfWorkerTarget {
  to(target: 'container' | 'canvas' | 'img' | 'pdf'): Html2PdfWorkerSave;
}

declare interface Html2PdfWorkerSave {
  save(fileName?: string): PromiseLike<void>;
}

declare interface Html2PdfworkerOptions {
  set(opt: Html2PdfWorkerOptions): Html2PdfWorkerRoot;
}

declare interface Html2PdfWorkerOptions {
  margin?: number | number[2] | number[4];
  filename?: string;
  image?: { type?: string; quality?: number; [key: string]: string | number | undefined };
  html2canvas?: { scale?: number };
  jsPdf: { unit?: string; format?: string; orientation?: 'portrait' | 'landscape' };
  enableLinks?: boolean;
}

We are using this package in our project and I did typings for my colleague. I hope it helps someone.

[chrisjung-dev]

Just an improved version using tuples definitions and deleting superfluous double definition

declare module 'html2pdf.js' {
  export default html2pdf;
}

declare function html2pdf(): Html2PdfWorkerRoot;
declare function html2pdf(
  element: Html2PdfElement,
  opt?: Html2PdfWorkerOptions
): void;

// declare type Html2PdfWorkerRoot = Html2PdfWorkerRoot;
declare type Html2PdfElement = string | HTMLElement;

declare interface Html2PdfWorkerRoot {
  from(
    element: Html2PdfElement,
    type?: 'string' | 'element' | 'canvas' | 'img'
  ): Html2PdfWorkerFrom;
}

declare interface Html2PdfWorkerContainer
  extends Html2PdfWorkerSave,
    Html2PdfWorkerTarget {
  toCanvas(): Html2PdfWorkerCanvas;
}

declare interface Html2PdfWorkerFrom
  extends Html2PdfWorkerSave,
    Html2PdfWorkerTarget,
    Html2PdfworkerOptions {
  toContainer(): Html2PdfWorkerContainer;
}

declare interface Html2PdfWorkerCanvas
  extends Html2PdfWorkerSave,
    Html2PdfWorkerTarget {
  toImg(): Html2PdfWorkerSave;
}

declare interface Html2PdfworkerImage
  extends Html2PdfWorkerSave,
    Html2PdfWorkerTarget {
  toPdf(): Html2PdfWorkerSave;
}

declare interface Html2PdfWorkerTarget {
  to(target: 'container' | 'canvas' | 'img' | 'pdf'): Html2PdfWorkerSave;
}

declare interface Html2PdfWorkerSave {
  save(fileName?: string): PromiseLike<void>;
}

declare interface Html2PdfworkerOptions {
  set(opt: Html2PdfWorkerOptions): Html2PdfWorkerRoot;
}

declare interface Html2PdfWorkerOptions {
  margin?: number | [number, number] | [number, number, number, number];
  filename?: string;
  image?: {
    type?: string;
    quality?: number;
    [key: string]: string | number | undefined;
  };
  html2canvas?: { scale?: number };
  jsPdf: {
    unit?: string;
    format?: string;
    orientation?: 'portrait' | 'landscape';
  };
  enableLinks?: boolean;
}

[agattaregmind]

Both versions was not supporting the new promise-based usage of the package so here is an updated versions that supports it

declare module 'html2pdf.js' {
    export default html2pdf
}

declare function html2pdf(): Html2PdfWorkerRoot
declare function html2pdf(element: Html2PdfElement, opt?: Html2PdfWorkerOptions): void

// declare type Html2PdfWorkerRoot = Html2PdfWorkerRoot;
declare type Html2PdfElement = string | HTMLElement

declare interface Html2PdfWorkerRoot {
    set(opt: Html2PdfWorkerOptions): Html2PdfWorkerRoot

    from(element: Html2PdfElement, type?: 'string' | 'element' | 'canvas' | 'img'): Html2PdfWorkerFrom
}

declare interface Html2PdfWorkerContainer extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
    toCanvas(): Html2PdfWorkerCanvas
}

declare interface Html2PdfWorkerFrom extends Html2PdfWorkerSave, Html2PdfWorkerTarget, Html2PdfWorkerOptions {
    toContainer(): Html2PdfWorkerContainer
}

declare interface Html2PdfWorkerCanvas extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
    toImg(): Html2PdfWorkerSave
}

declare interface Html2PdfWorkerImage extends Html2PdfWorkerSave, Html2PdfWorkerTarget {
    toPdf(): Html2PdfWorkerSave
}

declare interface Html2PdfWorkerTarget {
    to(target: 'container' | 'canvas' | 'img' | 'pdf'): Html2PdfWorkerSave
}

declare interface Html2PdfWorkerSave {
    save(fileName?: string): PromiseLike<void>
}

declare interface Html2PdfWorkerOptions {
    margin?: number | [number, number] | [number, number, number, number]
    filename?: string
    image?: {
        type?: string
        quality?: number
        [key: string]: string | number | undefined
    }
    html2canvas?: { scale?: number }
    jsPdf?: {
        unit?: string
        format?: string
        orientation?: 'portrait' | 'landscape'
    }
    enableLinks?: boolean
}

[youyoumu]

i think the type definition from this PR is very good #738

i'm gonna use this as html2pdf.js.d.ts until the PR is merged 8da5170