🤖 Merge PR #62603 Add type definition of package html-pdf-node on npm by @bojovypstros

* feat: add html-pdf-node types

* style: use package rules
This commit is contained in:
Matěj Kos
2022-10-11 07:56:42 +02:00
committed by GitHub
parent 0682901d9a
commit f36edcdf70
4 changed files with 107 additions and 0 deletions

View File

@@ -0,0 +1,36 @@
import { generatePdfs, generatePdf } from "html-pdf-node/index";
// $ExpectType void
generatePdf(
{
content: "<h1>Hello World!</h1>",
},
{
format: "A4",
printBackground: true,
},
(err, buffer) => {
// $ExpectType Buffer
buffer;
}
);
// $ExpectType void
generatePdfs(
[
{
content: "<h1>Hello World!</h1>",
},
{
content: "<h1>Hello World!</h1>",
}
],
{
format: "A4",
printBackground: true,
},
(err, buffer) => {
// $ExpectType Buffer
buffer;
}
);

47
types/html-pdf-node/index.d.ts vendored Normal file
View File

@@ -0,0 +1,47 @@
// Type definitions for html-pdf-node 1.0
// Project: https://github.com/mrafiqk/html-pdf-node#readme
// Definitions by: bojovypstros <https://github.com/bojovypstros>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <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 function generatePdf(
file: File,
options?: Options,
callback?: (err: Error, buffer: Buffer) => void,
): void;
export function generatePdfs(
files: File[],
options?: Options,
callback?: (err: Error, buffer: Buffer) => void,
): void;

View File

@@ -0,0 +1,23 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"html-pdf-node-tests.ts"
]
}

View File

@@ -0,0 +1 @@
{ "extends": "@definitelytyped/dtslint/dt.json" }