跳到主要内容

rxdb-plugin-search-react

@aiao/rxdb-plugin-search 的 React 集成层。提供 useSearch() hook,将搜索插件的 SearchHandle 适配为 React 状态消费接口。

安装

pnpm add @aiao/rxdb @aiao/rxdb-plugin-search @aiao/rxdb-plugin-search-react react rxjs

用法

import { useSearch } from '@aiao/rxdb-plugin-search-react';
  • useSearch:返回 SearchState(结果、加载态与错误)
  • 类型:UseSearchReturnSearchSourceLike

三框架同功能对称:Angular 用 injectSearch@aiao/rxdb-plugin-search-angular),Vue 用 useSearch@aiao/rxdb-plugin-search-vue)。

文档

License

MIT

Interfaces

InterfaceDescription
SearchExecutionError运行时执行错误(SQL 失败 / 存储不可用);可通过 SearchHandle.retry 恢复。
SearchHandlecollection.search() / rxDB.search() 返回的响应式句柄。
SearchOptions单次搜索请求的可调参数;可覆盖 SearchPluginOptions 全局默认。
SearchResult单条搜索命中。
SearchSourceLike暴露 search() 方法的最小数据源形状(RxDB / RxCollection)。
UseSearchReturnuseSearch 返回值。

Type Aliases

Type AliasDescription
SearchStateSearchHandle 状态机五态。

Functions

FunctionDescription
useSearchSearchHandle 的响应式输出适配为 React hook。