跳到主要内容

UseSearchReturn

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:41

useSearch 返回值。

Properties​

clear​

clear: () => void;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:62

清空查询并回到 idle

Returns​

void

error​

error: Readonly<Ref<
  | SearchExecutionError
  | undefined>>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:56

最近一次执行错误（只读）。

hasMore​

hasMore: Readonly<Ref<boolean>>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:58

是否还有下一页（只读）。

loadMore​

loadMore: () => Promise<void>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:60

加载下一页；无更多时 no-op

Returns​

Promise<void>

query​

query: Ref<string>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:43

可读写查询词；支持 v-model 与直接赋值。这是唯一可写的输出。

results​

results: Readonly<Ref<readonly SearchResult[]>>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:52

当前结果。

Remarks​

SRCHV-003：四个由 handle 驱动的输出一律只读。早先原样返回内部可写 Ref， 调用方能把 idle 伪造成 error，在下一次 Observable emission 之前 UI 与真实句柄永久分叉。Angular 用只读 Signal、React 只返回值，此处对齐。

retry​

retry: () => void;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:64

在 error 状态下以最后一次查询词重试

Returns​

void

state​

state: Readonly<Ref<SearchState>>;

Defined in: packages/rxdb-plugin-search-vue/src/use-search.ts:54

当前状态（只读，见 UseSearchReturn.results）。