npm 包 docfalcon-sdk 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

docfalcon-sdk 是一款针对文档生成工具 docfalcon 的 JavaScript SDK，旨在方便用户在 web 应用中调用 docfalcon API 生成高质量 PDF 文档。

在本文中，我们将介绍 docfalcon-sdk 的使用方法，包括安装、配置、API 接口及示例代码等内容。希望本文能够对前端开发者以及使用 docfalcon 的用户有所帮助。

安装

使用 npm 安装 docfalcon-sdk：

npm install docfalcon-sdk

配置

在使用 docfalcon-sdk 之前，你需要注册 docfalcon 账号并获取 API key。API key 需要在代码中进行配置。

使用以下方法配置 API key：

const DocFalconSDK = require("docfalcon-sdk");

const docfalcon = new DocFalconSDK({
  apiKey: "your_api_key_here",
  //other options here
});

API 接口

docfalcon-sdk 提供了以下 API 接口：

`generatePdf`

根据传入的 HTML/URL 生成 PDF 文件。

参数：

input (必填): 字符串类型。输入内容，可以是 HTML 字符串或者是 URL 地址。
options (可选): 对象类型。其他选项，包括 paperFormat、paperOrientation、dpi、showBackground、cookies、headers 等。
callback (可选): 生成 PDF 文件后的回调函数。如果传入该参数，则不会返回 Promise 实例。

返回值：

如果传入回调函数，则返回值为 undefined。否则返回 Promise 实例，可以使用 .then() 来获取结果。

示例代码：

docfalcon
  .generatePdf("<p>Hello DocFalcon</p>")
  .then((pdf) => {
    console.log(pdf); // pdf file as buffer
  })
  .catch((err) => {
    console.error(err);
  });

`getPdfStatus`

根据传入的 task ID 获取 PDF 的生成状态。

参数：

taskId (必填): 字符串类型。任务 ID。

返回值：

返回 Promise 实例，可以使用 .then() 来获取结果。

示例代码：

docfalcon
  .getPdfStatus("task_id")
  .then((status) => {
    console.log(status); // pdf status
  })
  .catch((err) => {
    console.error(err);
  });

`getPdf`

根据传入的 task ID 获取生成的 PDF 文件。

参数：

taskId (必填): 字符串类型。任务 ID。

返回值：

返回 Promise 实例，可以使用 .then() 来获取结果。

示例代码：

docfalcon
  .getPdf("task_id")
  .then((pdf) => {
    console.log(pdf); // pdf file as buffer
  })
  .catch((err) => {
    console.error(err);
  });

示例代码

完整的示例代码如下：

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

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

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

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

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

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

上述代码中，在生成 PDF 文件后，代码设置了一个倒计时定时器，等待 10 秒后使用任务 ID 获取 PDF 文件并打印到控制台上。你可以根据实际需求修改该部分代码。

结论

以上便是 docfalcon-sdk 的使用教程，希望能够帮助到开发者。docfalcon-sdk 的应用场景非常广泛，包括但不限于订单单据生成、财务报表生成、电子合同等。在使用过程中，如果遇到任何问题，可以参考官方文档或者在社区寻求帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600562a581e8991b448dfe42