web-dc-api 0.0.64 → 0.0.65

package/dist/index.d.ts

@@ -3279,7 +3279,10 @@ interface INet {
         token?: ThreadToken;
     }): Promise<ThreadInfo>;
     deleteThread(id: ThreadID, ...opts: any[]): Promise<void>;
-    pullThread(id: ThreadID, timeout: number, ...opts: any[]): Promise<void>;
+    pullThread(id: ThreadID, timeout: number, options: {
+        token?: ThreadToken | undefined;
+        multiPeersFlag?: boolean | undefined;
+    }): Promise<void>;
     getPbLogs(id: ThreadID): Promise<[net.pb.ILog[], IThreadInfo]>;
 }
 interface ICollectionConfig {
@@ -26970,7 +26973,7 @@ interface IKeyValueOperations {
      * @param kvdb: KeyValueDB,
      * @param key 键名
      * @param value 值内容
-     * @param indexs 索引列表，格式为"indexkey1:value$$$indexkey2:value",设置索引后,后续查询可以通过索引快速定位
+     * @param indexs 索引列表，格式为json字符串:[{key:"indexkey1",type:"string",value:"value"},{key:"indexkey2",type:"number", value:12}],设置索引后,后续查询可以通过索引快速定位
      * @param vaccount 可选的虚拟账户
      * @returns [是否设置成功, 错误信息]
      */
@@ -26979,13 +26982,13 @@ interface IKeyValueOperations {
      * 获取指定键的值
      * @param kvdb: KeyValueDB,
      * @param key 键名
-     * @param writerPubkey 写入者的公钥,可选,默认为主题作者
+     * @param writerPubkey 写入者的公钥,如果不指定，则获取所有用户写入的该key的最新值
      * @param vaccount 可选的虚拟账户
      * @returns [值内容, 错误信息]
      */
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
-      * 获取指定键的值列表,包括所有用户写入的值,可以用在类似排名这些需要多人数据汇总的场景,key为场景名称,各个用户写入的值为各自在该场景下的内容
+      * 获取指定键的值列表,按key的字典序排序
       * @param kvdb: KeyValueDB,
       * @param key 键名
       * @param limit 返回结果数量限制
@@ -26995,7 +26998,12 @@ interface IKeyValueOperations {
       * @param vaccount 可选的虚拟账户
       * @returns [值列表生成的json字符串, 错误信息]
       */
-    getValues(kvdb: KeyValueDB, key: string, limit: number, seekKey: string, direction: Direction, offset: number, vaccount?: string): Promise<[string | null, Error | null]>;
+    getValues(kvdb: KeyValueDB, key: string, options: {
+        limit?: number;
+        seekKey?: string;
+        direction?: Direction;
+        offset?: number;
+    }, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
      * 批量获取多个键的值
      * @param kvdb: KeyValueDB,
@@ -27010,6 +27018,7 @@ interface IKeyValueOperations {
      * @param kvdb: KeyValueDB,
      * @param indexKey 索引键名
      * @param indexValue 索引值
+     * @param type 索引值类型
      * @param seekKey 查询起始键
      * @param offset 结果偏移量
      * @param direction 查询方向 (Forward/Backward)
@@ -27017,7 +27026,13 @@ interface IKeyValueOperations {
      * @param vaccount 可选的虚拟账户
      * @returns [JSON格式查询结果, 错误信息]
      */
-    getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, limit: number, seekKey: string, offset: number, direction: Direction, vaccount?: string): Promise<[string | null, Error | null]>;
+    getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
+        type?: string;
+        limit?: number;
+        seekKey?: string;
+        direction?: Direction;
+        offset?: number;
+    }, vaccount?: string): Promise<[string | null, Error | null]>;
 }
 
 /**
@@ -28059,11 +28074,11 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     getStore(appId: string, theme: string, themeAuthor: string): Promise<[KeyValueDB | null, Error | null]>;
     configAuth(kvdb: KeyValueDB, authPubkey: string, permission: ThemePermission, remark: string, vaccount?: string): Promise<[number | null, Error | null]>;
     getAuthList(kvdb: KeyValueDB, vaccount?: string): Promise<[ThemeAuthInfo[] | null, ThemeComment[] | null, Error | null]>;
-    set(kvdb: KeyValueDB, key: string, value: string, indexs: string, //索引列表,格式为key1:value1$$$key2:value2
+    set(kvdb: KeyValueDB, key: string, value: string, indexs: string, //索引列表,格式为json字符串:[{key:"indexkey1",type:"string",value:"value"},{key:"indexkey2",type:"number", value:12}],这里统一转换格式为key1:value1$$$key2:value2
     vaccount?: string): Promise<[boolean | null, Error | null]>;
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
-    * 获取指定键的值列表,包括所有用户写入的值,可以用在类似排名这些需要多人数据汇总的场景,key为场景名称,各个用户写入的值为各自在该场景下的内容
+    * 获取指定键的值列表
     * @param kvdb: KeyValueDB,
     * @param key 键名
     * @param limit 返回结果数量限制
@@ -28072,9 +28087,20 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     * @param vaccount 可选的虚拟账户
     * @returns [值列表生成的json字符串, 错误信息]
     */
-    getValues(kvdb: KeyValueDB, key: string, limit: number, seekKey: string, direction: Direction | undefined, offset: number, vaccount?: string): Promise<[string | null, Error | null]>;
+    getValues(kvdb: KeyValueDB, key: string, options: {
+        limit?: number;
+        seekKey?: string;
+        direction?: Direction;
+        offset?: number;
+    }, vaccount?: string): Promise<[string | null, Error | null]>;
     getBatch(kvdb: KeyValueDB, keys: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
-    getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, limit: number, seekKey: string, offset: number, direction?: Direction, vaccount?: string): Promise<[string | null, Error | null]>;
+    getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
+        type?: string;
+        limit?: number;
+        seekKey?: string;
+        direction?: Direction;
+        offset?: number;
+    }, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
      * 断言模块已初始化
      */