rxdb-plugin-search-vue
@aiao/rxdb-plugin-search 的 Vue 集成层。提供 useSearch() composable,将搜索插件的 SearchHandle 适配为 Vue ref / reactive 消费接口。
安装
pnpm add @aiao/rxdb @aiao/rxdb-plugin-search @aiao/rxdb-plugin-search-vue vue rxjs
用法
<script lang="ts" setup>
import { useSearch } from '@aiao/rxdb-plugin-search-vue';
</script>
useSearch:返回响应式的SearchState(结果、加载态与错误)- 类型:
UseSearchReturn、SearchSourceLike
三框架同功能对称:Angular 用 injectSearch(@aiao/rxdb-plugin-search-angular),React 用 useSearch(@aiao/rxdb-plugin-search-react)。
文档
- 仓库主页:https://github.com/aiao-io/aiao
- 框架集成与搜索指南见项目文档站
License
rxdb-plugin-search-vue - Vue 集成层
提供 useSearch() composable,将 @aiao/rxdb-plugin-search 的 SearchHandle 适配为 Vue
ref / reactive 消费接口。
Interfaces
| Interface | Description |
|---|---|
| SearchExecutionError | 运行时执行错误(SQL 失败 / 存储不可用);可通过 SearchHandle.retry 恢复。 |
| SearchHandle | 由 collection.search() / rxDB.search() 返回的响应式句柄。 |
| SearchOptions | 单次搜索请求的可调参数;可覆盖 SearchPluginOptions 全局默认。 |
| SearchResult | 单条搜索命中。 |
| SearchSourceLike | 暴露 search() 方法的最小数据源形状(RxDB / RxCollection)。 |
| UseSearchReturn | useSearch 返回值。 |
Type Aliases
| Type Alias | Description |
|---|---|
| SearchState | SearchHandle 状态机五态。 |
Functions
| Function | Description |
|---|---|
| useSearch | 将 SearchHandle 的响应式输出适配为 Vue composable。 |