@topgroup/diginext
Version:
A BUILD SERVER & CLI to deploy apps to any Kubernetes clusters.
64 lines • 1.89 kB
TypeScript
/// <reference types="node" />
/// <reference types="node" />
export type ExportPDFOptions = {
viewport?: {
/**
* The page width in pixels.
*/
width: number;
/**
* The page height in pixels.
*/
height: number;
/**
* Specify device scale factor.
* See {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio | devicePixelRatio} for more info.
*
* @remarks
* Setting this value to `0` will set the deviceScaleFactor to the system default.
*
* @defaultValue `1`
*/
deviceScaleFactor?: number;
/**
* Whether the `meta viewport` tag is taken into account.
* @defaultValue `false`
*/
isMobile?: boolean;
/**
* Specifies if the viewport is in landscape mode.
* @defaultValue `false`
*/
isLandscape?: boolean;
/**
* Specify if the viewport supports touch events.
* @defaultValue `false`
*/
hasTouch?: boolean;
};
printBackground?: boolean;
path?: string;
format?: "letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6";
scale?: number;
margin?: {
top?: string | number;
bottom?: string | number;
left?: string | number;
right?: string | number;
};
displayHeaderFooter?: boolean;
/**
* Hides default white background and allows generating pdfs with transparency.
* @defaultValue `false`
*/
omitBackground?: boolean;
};
declare const exportPdf: (url: string, options?: ExportPDFOptions) => Promise<{
name: string;
path: string;
url: string;
buffer: Buffer;
mime: string;
}>;
export default exportPdf;
//# sourceMappingURL=export-pdf.d.ts.map