可组合函数

searchContent()

这是一个实验性功能,使用 experimental.search 选项 选择加入。

用于搜索你的 content 目录。

const input = ref('')
const results = await searchContent(input)

参数

类型默认值描述
searchMaybeRefOrGetter<string>搜索输入
optionsSearchContentOptions{}选项
options.miniSearchMaybeRefOrGetter<MiniSearchOptions<T>>传递给 miniSearch 的选项
options.fetchMaybeRefOrGetter<UseFetchOptions<string | T>>传递给 useFetch 的选项

MiniSearchOptions

你可以使用 defineMiniSearchOptions 可组合函数轻松定义 miniSearch 选项

const miniSearchOptions = defineMiniSearchOptions({
  fields: ['title', 'description', 'body']
})

使用这些选项可以修改搜索的执行方式。你可以更改 搜索的字段、每个字段的权重等等

仅在使用简单搜索(即非索引搜索)时可用。

UseFetchOptions

提供了一个选项来自定义内部使用的 useFetch 可组合函数的行为,以便仅在客户端和延迟加载时获取搜索内容。这可以避免在 SSR 上获取内容并将内容添加到 _payload.json 文件中,从而提高应用程序的性能,因为 _payload 加载用于水合。