跳到主要内容

SearchHandle

Defined in: packages/rxdb-plugin-search/src/types.ts:83

由 collection.search() / rxDB.search() 返回的响应式句柄。

订阅 results$ 即触发查询管道;调用 SearchHandle.destroy 释放所有内部订阅。 框架绑定(Angular / React / Vue)会在生命周期末自动调用 destroy()。

Properties​

error$​

readonly error$: Observable<
| SearchExecutionError
| undefined>;

Defined in: packages/rxdb-plugin-search/src/types.ts:89

最近一次执行错误;空查询与归一化后为空不视为错误


hasMore$​

readonly hasMore$: Observable<boolean>;

Defined in: packages/rxdb-plugin-search/src/types.ts:91

是否还有下一页结果可加载


results$​

readonly results$: Observable<readonly Readonly<SearchResult>[]>;

Defined in: packages/rxdb-plugin-search/src/types.ts:85

响应式只读快照;数组与元素均在运行时冻结


state$​

readonly state$: Observable<SearchState>;

Defined in: packages/rxdb-plugin-search/src/types.ts:87

当前状态(便于非框架场景读取)

Methods​

clear()​

clear(): void;

Defined in: packages/rxdb-plugin-search/src/types.ts:97

清空查询词,回到 idle,清空 results / error / pagination

Returns​

void


destroy()​

destroy(): void;

Defined in: packages/rxdb-plugin-search/src/types.ts:101

取消订阅并释放资源(框架层自动调用)

Returns​

void


loadMore()​

loadMore(): Promise<void>;

Defined in: packages/rxdb-plugin-search/src/types.ts:95

加载下一页;无更多数据时 no-op

Returns​

Promise<void>


retry()​

retry(): void;

Defined in: packages/rxdb-plugin-search/src/types.ts:99

在 error 状态下以最后一次查询词重新触发

Returns​

void


setQuery()​

setQuery(query): void;

Defined in: packages/rxdb-plugin-search/src/types.ts:93

更新查询词(触发防抖)

Parameters​

ParameterType
querystring

Returns​

void