web-dc-api 0.0.69 → 0.0.70

package/dist/index.d.ts

@@ -26984,7 +26984,7 @@ interface IKeyValueOperations {
      * @param key 键名
      * @param writerPubkey 写入者的公钥,如果不指定，则获取所有用户写入的该key的最新值
      * @param vaccount 可选的虚拟账户
-     * @returns [值内容, 错误信息]
+     * @returns [值内容, 错误信息] 值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
@@ -26996,7 +26996,7 @@ interface IKeyValueOperations {
       * @param direction 查询方向
       * @param offset 结果偏移量
       * @param vaccount 可选的虚拟账户
-      * @returns [值列表生成的json字符串, 错误信息]
+      * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
       */
     getValues(kvdb: KeyValueDB, key: string, options: {
         limit?: number;
@@ -27010,7 +27010,7 @@ interface IKeyValueOperations {
      * @param keys 多个键名，逗号分隔
      * @param writerPubkey 写入者的公钥,可选,默认为主题作者
      * @param vaccount 可选的虚拟账户
-     * @returns [JSON格式值内容, 错误信息]
+     * @returns [JSON格式值内容, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     getBatch(kvdb: KeyValueDB, keys: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
@@ -27024,7 +27024,7 @@ interface IKeyValueOperations {
      * @param direction 查询方向 (Forward/Backward)
      * @param limit 返回结果数量限制
      * @param vaccount 可选的虚拟账户
-     * @returns [JSON格式查询结果, 错误信息]
+     * @returns [JSON格式查询结果, 错误信息] 每个值的格式: value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
         type?: string;
@@ -28076,6 +28076,14 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     getAuthList(kvdb: KeyValueDB, vaccount?: string): Promise<[ThemeAuthInfo[] | null, ThemeComment[] | null, Error | null]>;
     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]>;
+    /**
+     * 获取指定键的元数据
+     * @param kvdb
+     * @param key
+     * @param writerPubkey
+     * @param vaccount
+     * @returns  [值, 错误信息],值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+     */
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
     * 获取指定键的值列表
@@ -28085,7 +28093,7 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     * @param seekKey 查询起始键,用于分页查询
     * @param offset 结果偏移量
     * @param vaccount 可选的虚拟账户
-    * @returns [值列表生成的json字符串, 错误信息]
+    * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
     */
     getValues(kvdb: KeyValueDB, key: string, options: {
         limit?: number;
@@ -28093,7 +28101,27 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
         direction?: Direction;
         offset?: number;
     }, vaccount?: string): Promise<[string | null, Error | null]>;
+    /**
+     * 批量获取指定键的值
+     * @param kvdb KeyValueDB实例
+     * @param keys 逗号分隔的键列表
+     * @param writerPubkey 可选，指定写入者公钥
+     * @param vaccount 可选的虚拟账户
+     * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+     */
     getBatch(kvdb: KeyValueDB, keys: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
+    /**
+     * 获取指定索引的值
+     * @param kvdb KeyValueDB实例
+     * @param indexKey 索引键名
+     * @param indexValue 索引值
+     * @param type 索引值类型
+     * @param seekKey 查询起始键,用于分页查询
+     * @param direction 查询方向
+     * @param offset 结果偏移量
+     * @param vaccount 可选的虚拟账户
+     * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+     */
     getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
         type?: string;
         limit?: number;