跳到主要内容

SearchOptions

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:7

单次搜索请求的可调参数；可覆盖 SearchPluginOptions 全局默认。

Properties​

collections?​

optional collections?: readonly string[];

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:18

限定参与聚合的 collection（接受实体名或表名）；默认聚合插件级排除规则之外的 全部 searchable collection。包含未知名称或解析后范围为空时抛错（fail-fast）。

debounce?​

optional debounce?: number;

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:9

输入防抖窗口（ms）；默认 300，传 0 关闭防抖

initialQuery?​

optional initialQuery?: string;

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:20

订阅初次建立时立即执行的初始查询

pageSize?​

optional pageSize?: number;

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:11

单页返回条数；默认 50

snippetLength?​

optional snippetLength?: number;

Defined in: packages/rxdb-plugin-search/dist/types.d.ts:13

命中片段长度（字符数）；默认 120