跳到主要内容

ListOptions

Defined in: packages/rxdb-plugin-storage/src/storage.helpers.ts:59

metadata 列表查询选项。

Properties​

path?​

optional path?: string;

Defined in: packages/rxdb-plugin-storage/src/storage.helpers.ts:68

要列出的目录,省略即整库。

Remarks​

'' 与 '/' 等价,都表示根目录 —— 二者都会被 normalizeDirectoryPath 规范化为 '/'。 想要「根目录及其全部子目录」请显式传 ListOptions.recursive, 不要靠省略 path 来表达(STOR-005)。


recursive?​

optional recursive?: boolean;

Defined in: packages/rxdb-plugin-storage/src/storage.helpers.ts:76

是否连同子目录一起返回。

Default Value​

false(只返回 path 下的直属文件)

Remarks​

省略 path 时本选项无意义:不限定目录本就返回整库全部 metadata。