title: 类 Query

sidebarDepth: 2

Class:Query

英文原地址

lunr.Query()

new Query()

lunr.Query提供了一种编程方式来定义针对lunr.Index执行的查询。

最好使用 lunr.Index#query 方法来构造 lunr.Query，这样可以使用正确的索引字段预先初始化查询对象。

属性

presence:number

常量，用于表示关键词在匹配文档中必须以何种形式出现。

例子：

必须存在的查询术语

query.term('foo', { presence: lunr.Query.presence.REQUIRED })

wildcard

常量，用于表示在构造查询语句时自动插入哪种通配符。

这可以让我们将通配符添加到关键的开头和结尾，而不必手动进行任何字符串连接。

通配符常量可以按位组合从而选择前置通配符和后置通配符。

例子：

带有后置通配符的查询关键词

query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })

带有前置和后置通配符的查询关键词

query.term('foo', {
  wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING
})

方法

clause(clause) → {lunr.Query}

向该查询中添加一个lunr.Query~Clause。

除非查询短语包含要匹配的字段，否则将匹配所有字段。此外，查询短语默认的权重为1。

isNegated()

否定查询语句是指每个查询短语中都有一个禁止项。这些查询需要一些特殊的处理才能返回预期的结果。

term(term, options) → {lunr.Query}

将一个关键词添加到当前查询中，这将在组成此查询的短语列表中创建一个lunr.Query~Clause。

该词是按照原本的样子使用的，也就是说，这种方法不会进行关键词化。相反，应该在调用此方法之前转换为关键词或类似于关键词的字符串。

关键词将通过toString转换为字符串。多个关键词可以通过一个数组传递，数组中的每个关键词都将共享相同的配置项。

例子：

添加单个关键词。

query.term("foo")

向查询中添加单个关键词，并指定搜索字段、关键词权重提升和自动后置通配符。

query.term("foo", {
  fields: ["title"],
  boost: 10,
  wildcard: lunr.Query.wildcard.TRAILING
})

在将字符串用作关键词之前，使用lunr.tokenizer将其转换为搜索关键词。

query.term(lunr.tokenizer("foo bar"))

类型定义

Clause:Object

c lunr.Query中的短语包含了关键词以及关于如何将该关键词与lunr.Index匹配的详细信息。