总览

英文原地址

示例

可以使用下面的代码创建一个简单示例：

  1. var idx = lunr(function () {
  2.   this.field('title')
  3.   this.field('body')
  5.   this.add({
  6.     "title": "Twelfth-Night",
  7.     "body": "If music be the food of love, play on: Give me excess of it…",
  8.     "author": "William Shakespeare",
  9.     "id": "1"
  10.   })
  11. })

接下来搜索很简单：

  1. idx.search("love")

它将返回匹配到的文档列表，并给出其与搜索查询的匹配度的值和与之相关的元数据：

  1. [
  2.   {
  3.     "ref": "1",
  4.     "score": 0.3535533905932737,
  5.     "matchData": {
  6.       "metadata": {
  7.         "love": {
  8.           "body": {}
  9.         }
  10.       }
  11.     }
  12.   }
  13. ]

描述

Lunr.js 是一个在浏览器中使用的小型全文搜索库。它对 JSON 文档进行索引，并提供一个简单的搜索接口，用于检索与文本查询最佳匹配的文档。

为什么使用它？

对于所有数据都在客户端中存储的 web 应用程序，能够在客户端上搜索这些数据意义重大。它省去了在服务器上添加额外压缩服务的工作。本地搜索的速度也更快，没有网络开销，即使没有网络连接也能保持可用性。

安装

只要在您想要使用的页面中引入 Lunr.js 文件即可。所有现代浏览器都支持 Lunr.js。

也可以使用npm install lunr包进行安装。

不支持ES5的浏览器需要 JavaScript shim 才能让 Lunr 工作。您可以使用Augment.js、ES5- shim 或任何对让浏览器与 ES5 兼容的 JavaScript 库。