npm 包 rabbit 使用教程

简介

rabbit 是一款基于 Node.js 和 Puppeteer 的工具包,用于将网页转换为 PDF 或图片。它支持从网页截取所需区域,并可以自定义页边距、页眉页脚等样式。rabbit 支持命令行和 API 两种调用方式,是前端开发中一款非常实用的工具。

安装

使用 npm 安装 rabbit

--- ------- ------ ------

或者全局安装:

--- ------- -- ------

使用方法

命令行调用

命令行调用 rabbit,需要先在命令行中输入 rabbit,然后加上需要转换的网址和一些可选参数:

------ ------------------ ------ --- -------- ----------- --------- -----

其中,--type 指定输出类型,可以是 pdfimage--output 指定输出文件路径;--timeout 指定页面加载超时时间。

API 调用

使用 rabbit 的 API 调用,需要先导入 rabbit 模块:

----- ------ - ------------------

然后,可以调用 rabbitgenerate 方法来生成 PDF 或图片:

-----------------
  -------- ---------------------
  ------- --------------
  ----- ------
  ------- -
    ---- ------
    ----- ------
    ------- ------
    ------ -----
  -
---------- -- -
  ---------------- --------- ---------------
---------------- -- -
  ---------------------
---

其中,generate 方法接受一个配置对象,包含属性:

  • pageUrl(必须):要转换的网页的链接。
  • output(必须):输出文件的路径。
  • type:输出文件的类型,可以是 pdfimage
  • margin:页面的页边距,可以是一个数字表示所有边距相同,也可以是一个对象表示每个边距的不同值。
  • headerTemplate:自定义的页眉模板。
  • footerTemplate:自定义的页脚模板。
  • waitUntil:页面加载的事件,可以是 loaddomcontentloadednetworkidle0
  • timeout:页面加载的最长等待时间,单位是毫秒。

在生成 PDF 或图片之前,还可以使用 rabbbitprepareBrowser 方法预加载浏览器:

------------------------------- -- -
  -------------------- -- --------
---------------- -- -
  ---------------------
---

示例代码

----- ------ - ------------------

------------------------------- -- -
  ------ -----------------
    -------- ---------------------
    ------- -------------
    ----- ------
    ------- -
      ---- ------
      ----- ------
      ------- ------
      ------ -----
    --
    --------------- ----- ----------------- ----- ----------- -----------------------
    --------------- ----- ----------------- ----- ----------- ------------- ----- -------------------------- -- ----- ----------------------------------
    ---------- ---------------
    -------- -----
  ---
---------- -- -
  ---------------- --------- ---------------
---------------- -- -
  ---------------------
---

总结

本文介绍了如何使用 rabbit 将网页转换为 PDF 或图片。无论是命令行还是 API 调用,都是非常简单的操作。通过本文的学习,读者可以更好地了解如何使用 rabbit 快速生成自己需要的文档或图片。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/80971


猜你喜欢

  • npm 包 absolution 使用教程

    在前端开发中,我们常常需要进行数值的计算和处理,此时一些数学函数能够帮助我们轻松地实现这些功能。其中,绝对值函数 (abs) 是我们经常用到的一个数学函数,它可以求出一个数的绝对值,例如,-5 的绝对...

    5 年前
  • npm 包 extend 使用教程

    在前端开发中,有时候我们需要合并两个或多个对象,或者给一个对象添加一个或多个属性,这时候就需要使用到 extend 包。extend 是一个基于 JavaScript 的 npm 包,它为我们提供了一...

    5 年前
  • npm 包 apostrophe-snippets 使用教程

    简介 apostrophe-snippets 是一个开源的 npm 包,可以帮助前端开发人员快速构建零散内容的新闻、博客、电影等网站页面。(https://www.npmjs.com/package/...

    5 年前
  • npm 包 apostrophe-schemas 使用教程

    在前端开发中,经常需要创建复杂的数据模型和表单。为了提高开发效率和减少重复工作,我们可以使用 npm 包 apostrophe-schemas 来帮助我们快速构建数据模型和表单。

    5 年前
  • npm 包 orthodox-spec 使用教程

    在前端开发过程中,我们通常需要创建多个模块或组件,而这些模块或组件在不同的业务场景中需要满足相应的规范和标准。为此,我们可以使用 npm 包 orthodox-spec 来管理规范和标准,从而提高开发...

    5 年前
  • npm 包 orthodox 使用教程

    简介 Orthodox 是一个基于 JavaScript 的前端组件库,具有高度定制性和灵活性。它包括多个组件,包括按钮、表单、布局和导航等常用的 UI 元素。与其他组件库不同,Orthodox 的设...

    5 年前
  • npm 包 apostrophe-site 使用教程

    在前端开发中,有许多优秀的 npm 包可以帮助我们快速搭建一个完整的网站并且提高开发效率。其中一款值得推荐的 npm 包就是 apostrophe-site,这是一个基于 Node.js 和 Expr...

    5 年前
  • npm 包 sum 使用教程

    什么是 npm 包? npm 包(Node Package Manager)是指 Node.js 的包管理器,它是将应用程序与对应的依赖打包到一起的一种方式。在前端开发中,我们常常使用 npm 包来管...

    5 年前
  • npm 包 porter-stemmer 使用教程

    在自然语言处理中,词干提取 (stemming) 是一个常用的技术手段。它可以将不同时态、不同形式的单词转化为同一个基本形式。比如,"run"、"running"、"ran" 都可以转化为 "run"...

    5 年前
  • `npm` 包 `pouchdb-node` 使用教程

    简介 pouchdb-node 是一个基于 CouchDB 和 PouchDB 的 Node.js 客户端,用于存储和检索本地数据。该包提供了一个轻量级的 NoSQL 数据库,允许开发者在应用程序中使...

    5 年前
  • npm 包 pouchdb-extended 使用教程

    简介 pouchdb-extended 是一个支持在浏览器和 Node.js 环境下使用的 NoSQL 数据库。它可以为数据提供本地化存储,并且与 CouchDB 完全兼容,支持 CouchDB 的所...

    5 年前
  • npm 包 localstorage-down 使用教程

    随着前端技术的发展,越来越多的开发者开始注重数据的本地存储及管理。在前端数据的本地存储管理中,localStorage 是常用的一种方式。然而在使用 localStorage 时,我们常常需要将其数据...

    5 年前
  • npm 包 wanache-core 使用教程

    介绍 wanache-core 是一个用于构建基于以太坊的去中心化应用(DApp)的 JavaScript 库。透过该库,开发者可以很容易地与以太坊网络进行交互,并且实现智能合约的交互。

    5 年前
  • npm 包 wanchainjs-tx 使用教程

    wanchainjs-tx 是一个用于 Wanchain 区块链的 JavaScript 库,它可以帮助开发者创建和签名交易并在链上广播。本文将详细介绍如何使用这个 npm 包。

    5 年前
  • npm 包 wanchain-dapp-connect 使用教程

    在区块链应用开发中,一个常见的做法是通过与智能合约交互来提交或者获取信息。然而,常常我们需要通过前端与智能合约进行交互,这就需要我们使用一些工具和技术。其中一个比较常用的工具就是 wanchain-d...

    5 年前
  • npm 包 wanchain-js-sdk 使用教程

    Wanchain-js-sdk 是一个在 Wanchain 区块链上进行开发的 JavaScript SDK。本文将为您讲解如何使用这个 npm 包。 安装 要开始使用 wanchain-js-sdk...

    5 年前
  • npm 包 vipstarcoinjs-lib 使用教程

    简介 vipstarcoinjs-lib 是一个用于 VIPSTARCOIN 区块链的 JavaScript 库,可以用于操作钱包、交易和合约等。该库基于 Node.js 环境,并在 npm 上提供了...

    5 年前
  • npm 包 sochain 使用教程

    简介 sochain 是一个基于区块链技术的 API 提供商,提供了面向开发者的区块链 API 接口。其官方提供的 npm 包 sochain 可以方便地在前端项目中使用。

    5 年前
  • npm 包 sotoolchain 使用教程

    随着前端技术的不断发展,越来越多的工具被开发出来帮助开发人员提高效率。其中,npm 是前端开发领域中非常重要的工具之一,它可以帮助我们管理和安装以 JavaScript 为基础的包和模块。

    5 年前
  • npm 包 dev-htmlcoinjs-lib 使用教程

    前言 当涉及到 HTMLCOIN 区块链开发时,htmlcoinjs-lib 是一个非常有用的工具。它用于生成 HTMLCOIN 钱包地址,签署交易,创建并解析脚本,以及许多其他功能。

    5 年前

相关推荐

    暂无文章