npm.io
1.0.3 • Published 4 months ago

@types/html-pdf-node

Licence
MIT
Version
1.0.3
Deps
1
Size
5 kB
Vulns
0
Weekly
0
Stars
51.5K

Installation

npm install --save @types/html-pdf-node

Summary

This package contains type definitions for html-pdf-node (https://github.com/mrafiqk/html-pdf-node#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/html-pdf-node.

index.d.ts

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

export interface File {
    url?: string | undefined;
    content?: string | undefined;
}

export interface OptionsMargin {
    top?: string | number | undefined;
    right?: string | number | undefined;
    bottom?: string | number | undefined;
    left?: string | number | undefined;
}

export interface Options {
    args?: string[] | undefined;
    path?: string | undefined;
    scale?: number | undefined;
    displayHeaderFooter?: boolean | undefined;
    headerTemplate?: string | undefined;
    footerTemplate?: string | undefined;
    printBackground?: boolean | undefined;
    landscape?: boolean | undefined;
    pageRanges?: string | undefined;
    format?: string | undefined;
    width?: string | number | undefined;
    height?: string | number | undefined;
    margin?: OptionsMargin | undefined;
    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,
): Promise<Buffer>;

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

Additional Details

  • Last updated: Wed, 27 May 2026 2249 GMT
  • Dependencies: @types/node

Credits

These definitions were written by bojovypstros.