npm 包 pouchdb-show 使用教程

阅读时长 4 分钟读完

什么是 PouchDB

PouchDB 是一个可用于浏览器和 Node.js 的开源 JavaScript 数据库。它是 CouchDB 的 JavaScript 实现,实现了一个彻底离线的体验,适用于在离线时工作,然后与服务器同步的应用程序。PouchDB 支持索引、 MapReduce 和查询,还支持插件。

什么是 pouchdb-show

PouchDB-show 是 PouchDB 的插件之一,它允许使用者编写简单的视图函数,根据您的数据库中存储的文档来生成显示。 您可以使用 PouchDB-show 显示您的单个文档,也可以生成与您的文档一起呈现的 HTML。PouchDB-show 充分利用了这一点,使您能够使用您最喜欢的模板库轻松构建页面。PouchDB-show 还提供了默认模板,所以您不需要在第一天就做所有的重复工作。

安装 pouchdb-show

首先,确保您已经在项目中安装了 PouchDB。然后通过使用 npm 进行安装,执行以下命令:

用法

添加视图

要添加视图,请在将文档添加到 PouchDB 之前定义视图。视图是一个可以根据文档内容生成输出的函数,可以选择附加到 $.show 属性并通过 PouchDB.show 函数调用。 下面是一个例子:

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

--------
  ---- ------
  ------- -------
---------------- -- -
  ------ ---------------------------
---------------- ---------- -
  ---------------------- -- --- ------
---
展开代码

在这个例子中,我们创建了一个名为 “doc” 的文档,在这个文档中定义了一个称为 “prop”的属性并为其设置了一个值。 我们然后在此文档上调用 db.show()。

接下来,定义视图函数:

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

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

--------------------------------- -- ----
展开代码

视图函数必须返回一个表示要在浏览器中显示的String。 要在“myshow”视图中使用视图函数,您需要将其附加到表示设计文档的对象中,然后将整个对象传递给 PouchDB.put。 保存后,就会在代码中包含的服务器和浏览器上运行您的的视图。

调用视图

PouchDB.show() 接受三个参数:设计文档名,视图名称和选项(可选)。在下面的示例中,我们使用“mydesign/myshow”这样的字符串作为设计文档名,使用“myshow”作为视图名称:

查看 HTML 模板

与视图函数一样,您也可以在 PouchDB-design-document 的显示属性中编写 HTML 模板以显示特定的文档。模板是一个简单的 String,您可以使用模板语言插入数据。下面是一个例子:

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

--------------------------------- -- ----
展开代码

在这个例子中,我们只定义了视图,但可以在设计文档中添加多个视图和生成器。

结论

PouchDB-show 插件允许您使用简单的 JavaScript 函数或 HTML 模板函数生成显示。它很容易入手,是 PouchDB 插件中最受欢迎的之一。可以使用 PouchDB-show 显示您的单个文档,也可以为多个文档生成 HTML 片段。该插件还为您提供了一个默认模板,因此您不必从头开始编写所有 HTML。希望这篇教程介绍了 pouchdb-show 的用法和基本原理,并帮助您开始开发。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/61117

纠错
反馈

纠错反馈