介绍
paper-handler 是一个基于 Node.js 的 Node Package Manager（npm）包，提供了一个简单的 API，用于生成 PDF、PNG 和 JPEG 文件。该包支持多种自定义选项，包括纸张大小、方向、边界、颜色、字体等等。在前端开发中，paper-handler 可以用于生成打印或下载用的 PDF 文件或在画布上生成图片。
安装
在使用 paper-handler 之前，你需要在你的项目中安装它。你可以在命令行中运行以下命令来完成安装：
npm install paper-handler
确保在安装之前已经安装了 Node.js。
使用方法
使用 paper-handler 很简单，只需要在你的应用程序中导入它和一些参数，你就可以开始使用了。以下是一个示例：
-- -------------------- ---- -------
----- ------------ - -------------------------
------------------------
-------- -
--------- -----
------
------
--------- ----------
------- -- - --- --------- -- ------------- -----------
-------
-------
--
--------- -----
---------- ------
--
----------- -- -
---------------- ----------------------
--
------------ -- -
----------------- --- -----------------
---该示例将生成一个包含 <!DOCTYPE html><html><body><h1>Hello World</h1><p>This is a PDF generated by paper-handler package</p></body></html> 内容的 PDF 文件，并使用 A4 纸张大小和纵向方向。
createPNG 和 createJPEG 方法的使用方法也类似。createPNG 和 createJPEG 可以使用指定大小和颜色的画布生成 PNG 或 JPEG 文件。以下是使用 createPNG 生成 PNG 文件的示例代码：
-- -------------------- ---- -------
------------------------
------ ----
------- ----
---------------- -------
-------- -
--------- -----
------
------
--------- ----------
------- -- - --- --------- -- ------------- -----------
-------
-------
--
--
----------- -- -
---------------- ----------------------
--
------------ -- -
----------------- --- -----------------
---参数
以下是可以传递给 createPDF、createPNG 和 createJPEG 方法的所有参数：
| 参数名 | 类型 | 描述 |
|---|---|---|
content |
字符串 | 必需。要转换为 PDF、PNG 或 JPEG 的 HTML 内容。 |
pageSize |
字符串 | 可选。PDF 纸张大小（如 "A4" 或 "Letter"）。默认为 "A4"。 |
landscape |
布尔值 | 可选。PDF 方向。如果设置为 true，则为横向。默认为 false。 |
margin |
对象 | 可选。PDF 的边距。可以分别设置 top、right、bottom 和 left。默认为 { top: "1cm", right: "1cm", bottom: "1cm", left: "1cm" }。 |
format |
字符串 | 可选。生成的图片格式。可以为 "png" 或 "jpeg"。默认为 "png"。 |
quality |
数字 | 可选。生成 JPEG 图片时的质量，仅在 format 为 "jpeg" 时生效。默认为 0.8。 |
backgroundColor |
字符串 | 可选。生成图片时的背景颜色。可以是颜色代码或颜色名称。默认为 "transparent"。 |
width |
数字 | 可选。生成 PNG 或 JPEG 图片的宽度。默认为 800。 |
height |
数字 | 可选。生成 PNG 或 JPEG 图片的高度。默认为 600。 |
dpi |
数字 | 可选。生成图片时的 DPI（每英寸点数）。默认为 300。 |
font |
字符串 | 可选。要使用的字体文件路径。 |
结论
paper-handler 是一个非常实用的 npm 包，可以轻松地生成 PDF、PNG 和 JPEG 文件。它提供了很多自定义选项，可以帮助你生成符合你需求的文件。此外，它使用简单易懂的 API，几行代码即可生成文件。如果你需要为你的应用程序生成 PDF、PNG 或 JPEG 文件，那么 paper-handler 绝对是一个不错的选择。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055aa481e8991b448d81ac