dolphindb 2.0.901 → 2.0.903

package/index.d.ts

@@ -10,7 +10,8 @@ export declare enum DdbForm {
     dict = 5,
     table = 6,
     chart = 7,
-    /** Node internal communication may be used, calling function execution script generally does not return this type */
+    /** 结点内部通信可能会使用，调用函数执行脚本一般不会返回这种类型
+        Node internal communication may be used, calling function execution script generally does not return this type */
     chunk = 8,
     /** sysobj */
     object = 9
@@ -96,15 +97,15 @@ export interface DdbDurationValue {
     data: number;
 }
 export interface DdbDecimal32Value {
-    /** int32, data needs to be divided by 10^scale to get the original value */
+    /** int32, data 需要除以 10^scale 得到原值  data needs to be divided by 10^scale to get the original value */
     scale: number;
-    /** int32, ddb null is js null */
+    /** int32, 空值为 null  ddb null is js null */
     data: number | null;
 }
 export interface DdbDecimal64Value {
-    /** int32, data needs to be divided by 10^scale to get the original value */
+    /** int32, data 需要除以 10^scale 得到原值  data needs to be divided by 10^scale to get the original value */
     scale: number;
-    /** int32, ddb null is js null */
+    /** int64, 空值为 null  empty value is null */
     data: bigint | null;
 }
 export interface DdbDecimal32VectorValue {
@@ -147,7 +148,7 @@ export declare enum DdbChartType {
     kline = 8
 }
 export interface DdbChartValue {
-    /** original: chartType */
+    /** 原属性 chartType  original: chartType */
     type: DdbChartType;
     stacking: boolean;
     /** 直方图 (Histogram), plotHist 函数返回的 chart 可能具有该属性
@@ -197,7 +198,7 @@ export declare const nulls: {
     readonly double: number;
     readonly bytes16: Uint8Array;
 };
-/** Can represent data types in all DolphinDB databases */
+/** 可以表示所有 DolphinDB 数据库中的数据类型  Can represent data types in all DolphinDB databases */
 export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     static dec: TextDecoder;
     static enc: TextEncoder;
@@ -229,7 +230,7 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     rows?: number;
     /** 第 2 维 */
     cols?: number;
-    /** The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
+    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据  The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
     value: TValue;
     /** 原始二进制数据，仅在 parse_object 为 false 时通过 parse_message 生成的顶层对象有这个属性 */
     buffer?: Uint8Array;
@@ -257,10 +258,12 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     /** 转换 js 数组为 DdbObj[] */
     static to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
-    /** convert dict<string, any> to js object (Record<string, any>)
+    /** 将 dict<string, any> 自动转换为 js object (Record<string, any>)  convert dict<string, any> to js object (Record<string, any>)
         - options?:
-            - strip?: `false` Whether to directly extract and strip the value in DdbObj as the value of js object (discard the rest of the information in DdbObj, only keep the value)
-            - deep?: `false` Whether to convert recursively
+            - strip?: `false` 是否将 DdbObj 中的 value 直接提取、剥离出来作为 js object 的 value (丢弃 DdbObj 中的其余信息，只保留 value)
+                Whether to directly extract and strip the value in DdbObj as the value of js object (discard the rest of the information in DdbObj, only keep the value)
+            - deep?: `false` 是否递归转换
+                Whether to convert recursively
     */
     to_dict<T extends Record<string, DdbObj> = Record<string, DdbObj>>(): T;
     to_dict<T extends Record<string, any> = Record<string, any>>(options: {
@@ -273,12 +276,12 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
 }
 export interface InspectOptions extends UtilInspectOptions {
     colors?: boolean;
-    /** decimal places */
+    /** `null` decimal places 小数位数 */
     decimals?: number;
 }
-/** Formats a single element (value) as a string according to DdbType, null returns a 'null' string */
+/** 根据 DdbType 格式化单个元素 (value) 为字符串，空值返回 'null' 字符串  Formats a single element (value) as a string according to DdbType, null returns a 'null' string */
 export declare function format(type: DdbType, value: DdbValue, le: boolean, options?: InspectOptions): string;
-/** formatted vector, the index-th item in the collection is a string, a null value returns a 'null' string */
+/** 格式化向量、集合中的第 index 项为字符串，空值返回 'null' 字符串  formatted vector, the index-th item in the collection is a string, a null value returns a 'null' string */
 export declare function formati(obj: DdbVectorObj, index: number, options?: InspectOptions): string;
 export declare class DdbVoid extends DdbObj<undefined> {
     constructor();
@@ -340,10 +343,9 @@ export declare class DdbSetDouble extends DdbObj<Float64Array> {
 export declare class DdbSetString extends DdbObj<string[]> {
     constructor(strings: string[] | Set<string>);
 }
-/** Constructs a DdbDict object, which supports two usages:
-     - The incoming type is the keys of DdbObj<DdbVectorValue>, and the two parameters of values directly form the DdbDict of dict<keys.type, values.type>
-     - Pass in js object (type is Record<string, boolean | string | DdbObj>), automatically converted to DdbDict of dict<string, any>
-*/
+/** 构造 DdbDict 对象，支持两种用法:  Constructs a DdbDict object, which supports two usages:
+     - 传入类型是 DdbVectorObj 的 keys, values 两个参数直接组成 dict<keys.type, values.type> 的 DdbDict  The incoming type is the keys of DdbObj<DdbVectorValue>, and the two parameters of values directly form the DdbDict of dict<keys.type, values.type>
+     - 传入 js object (类型是 Record<string, boolean | string | DdbObj>), 自动转换为 dict<string, any> 的 DdbDict  Pass in js object (type is Record<string, boolean | string | DdbObj>), automatically converted to DdbDict of dict<string, any> */
 export declare class DdbDict extends DdbObj<DdbDictValue> {
     constructor(obj: Record<string, boolean | string | DdbObj>);
     constructor(keys: DdbVectorObj, values: DdbVectorObj);
@@ -367,15 +369,17 @@ export declare function timestamp2ms(timestamp: bigint | null): number | null;
 /** format timestamp (bigint) to string
     - timestamp: bigint value
     - format?:
-        format string, default to `YYYY.MM.DD HH:mm:ss.SSS`
+        格式串，默认是 `YYYY.MM.DD HH:mm:ss.SSS`  format string, default to `YYYY.MM.DD HH:mm:ss.SSS`
         https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
 */
 export declare function timestamp2str(timestamp: bigint | null, format?: string): string;
 export declare function datehour2ms(datehour: number | null): number | null;
 export declare function datehour2str(datehour: number | null, format?: string): string;
 /** parse timestamp string to bigint value
-    - str: timestamp string, If it is an empty string or 'null', it will return the corresponding empty value (nulls.int64)
+    - str: str: timestamp string, 如果为空字符串或 'null' 会返回对应的空值 (nulls.int64)
+        timestamp string, If it is an empty string or 'null', it will return the corresponding empty value (nulls.int64)
     - format?:
+        对应传入字符串的格式串，默认是 `YYYY.MM.DD HH:mm:ss.SSS`
         The format string corresponding to the incoming string, the default is `YYYY.MM.DD HH:mm:ss.SSS`
         https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
 */
@@ -386,16 +390,17 @@ export declare function nanotimestamp2ns(nanotimestamp: bigint | null): bigint |
 /** format nanotimestamp value (bigint) to string
     - nanotimestamp: bigint value
     - format?:
-        format string, default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
-        Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
+        格式串，默认是 `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`  format string, default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
+        秒的格式为 ss (必须包含); 纳秒的格式为 SSSSSSSSS (必须包含)  Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
         https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
 */
 export declare function nanotimestamp2str(nanotimestamp: bigint | null, format?: string): string;
 /** parse nano timestamp string to bigint value
-    - str: nano timestamp string, If it is an empty string or 'null', it will return the corresponding empty value (nulls.int64)
+    - str: nano timestamp string, 如果为空字符串或 'null' 会返回对应的空值 (nulls.int64)
+        nano timestamp string, If it is an empty string or 'null', it will return the corresponding empty value (nulls.int64)
     - format?:
-        The format string corresponding to the incoming string, the default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
-        Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
+        对应传入字符串的格式串，默认是 `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`  The format string corresponding to the incoming string, the default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
+        秒的格式为 ss (必须包含); 纳秒的格式为 SSSSSSSSS (必须包含)  Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
         https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
 */
 export declare function str2nanotimestamp(str: string, format?: string): bigint;
@@ -409,30 +414,32 @@ export interface StreamingParams {
 }
 export interface StreamingData extends StreamingParams {
     /**
-        The time the server sent the message (nano seconds since epoch)
+        server 发送消息的时间 (nano seconds since epoch)  The time the server sent the message (nano seconds since epoch)
         std::chrono::system_clock::now().time_since_epoch() / std::chrono::nanoseconds(1)
     */
     time: bigint;
     /** message id */
     id: bigint;
     colnames: string[];
-    /** Subscription topic, which is the name of a subscription.
-        It is a string consisting of the alias of the node where the subscription table is located, the stream data table name, and the subscription task name (if actionName is specified), separated by `/`
-    */
+    /** 订阅主题，即一个订阅的名称。  Subscription topic, which is the name of a subscription.
+        它是一个字符串，由订阅表所在节点的别名、流数据表名称和订阅任务名称（如果指定了 actionName）组合而成，使用 `/` 分隔
+        It is a string consisting of the alias of the node where the subscription table is located, the stream data table name, and the subscription task name (if actionName is specified), separated by `/` */
     topic: string;
-    /** Stream data, the type is any vector, each element of which corresponds to a column (without name) of the subscribed table, and the content in the column (DdbObj<DdbVectorValue>) is the new data value */
+    /** 流数据，类型是 any vector, 其中的每一个元素对应被订阅表的一个列 (没有 name)，列 (DdbObj<DdbVectorValue>) 中的内容是新增的数据值
+        Stream data, the type is any vector, each element of which corresponds to a column (without name) of the subscribed table, and the content in the column (DdbObj<DdbVectorValue>) is the new data value */
     data: DdbObj<DdbVectorObj[]>;
-    /** Number of new streaming data rows */
+    /** 新增的流数据行数  Number of new streaming data rows */
     rows: number;
     window: {
-        /** The establishment of the connection starts offset = 0, and gradually increases as the window moves */
+        /** 建立连接开始 offset = 0, 随着 window 的移动逐渐增加  The establishment of the connection starts offset = 0, and gradually increases as the window moves */
         offset: number;
-        /** sum of segment.row in segments */
+        /** segments 中 segment.row 的总和  sum of segment.row in segments */
         rows: number;
-        /** An array of data received each time */
+        /** 每次接收到的 data 组成的数组  An array of data received each time */
         segments: DdbObj<DdbVectorObj[]>[];
     };
-    /** After successfully subscribed, if the subsequently pushed message is parsed incorrectly, the error will be set and the handler will be called. */
+    /** 成功订阅后，后续推送过来的 message 解析错误，则会设置 error 并调用 handler
+        After successfully subscribed, if the subsequently pushed message is parsed incorrectly, the error will be set and the handler will be called. */
     error?: Error;
 }
 export declare const winsize: 100000;
@@ -463,7 +470,7 @@ export declare class DDB {
     password: string;
     /** python session flag (2048) */
     python: boolean;
-    /** Whether it is a streaming data connection, this field is always null for non-streaming data */
+    /** 是否为流数据连接，非流数据这个字段恒为 null  Whether it is a streaming data connection, this field is always null for non-streaming data */
     streaming: StreamingData;
     print_message_buffer: boolean;
     print_object_buffer: boolean;
@@ -477,20 +484,20 @@ export declare class DDB {
     presult: Promise<any>;
     get connected(): boolean;
     /**
-        Initialize an instance of DolphinDB Client using the WebSocket URL
-        (without establishing an actual network connection)
+        使用 WebSocket URL 初始化连接到 DolphinDB 的实例（不建立实际的网络连接）
+        Initialize an instance of DolphinDB Client using the WebSocket URL (without establishing an actual network connection)
         - url: DolphinDB WebSocket URL. e.g.：`ws://127.0.0.1:8848`
         - options?:
-            - autologin?: Whether to log in automatically after establishing a connection, default `true`
-            - username?: DolphinDB username, default `'admin'`
-            - password?: DolphinDB password, default `'123456'`
-            - python?: set python session flag, default `false`
-            - streaming?: When this option is set, the WebSocket connection is only used for streaming data
+            - autologin?: 是否在建立连接后自动登录，默认 `true`  Whether to log in automatically after establishing a connection, default `true`
+            - username?: DolphinDB 登录用户名，默认 `'admin'`  DolphinDB username, default `'admin'`
+            - password?: DolphinDB 登录密码，默认 `'123456'`  DolphinDB password, default `'123456'`
+            - python?: 设置 python session flag，默认 `false`  set python session flag, default `false`
+            - streaming?: 设置该选项后，该 WebSocket 连接只用于流数据  When this option is set, the WebSocket connection is only used for streaming data
         
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
         
-        // Encrypt with HTTPS
+        // 使用 HTTPS 加密  Encrypt with HTTPS
         let ddbsecure = new DDB('wss://dolphindb.com', {
             autologin: true,
             username: 'admin',
@@ -506,9 +513,9 @@ export declare class DDB {
         streaming?: StreamingParams;
     });
     private on_message;
-    /** Establish a actual websocket connection to the DolphindB corresponding to the URL
-        It is a power, and after calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
-        this.autologin automatically log in when it is true */
+    /** 建立实际的 WebSocket 连接到 URL 对应的 DolphinDB  Establish a actual websocket connection to the DolphindB corresponding to the URL
+        是幂等的，调用后会确保已连接到数据库 (确保 websocket.readyState 为 open)，否则报错  It is a power, and after calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
+        this.autologin 为 true 时自动登录  this.autologin automatically log in when it is true */
     connect(): Promise<void>;
     get_rpc_options({ urgent, secondary, async: _async, pickle, clear, api, compress, cancellable, priority, parallelism, root_id, limit, }?: {
         urgent?: boolean;
@@ -535,7 +542,7 @@ export declare class DDB {
     }): string;
     disconnect(): void;
     /** rpc through websocket (function/script/variable command)
-        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
+        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 ConnectionError  When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -554,11 +561,15 @@ export declare class DDB {
         parse_object?: boolean;
     }): Promise<T>;
     /** eval script through websocket (script command)
-        - script?: Script to execute
-        - options?: execution options
-            - urgent?: Urgent flag to ensure that submitted scripts are processed by urgent workers to prevent being blocked by other jobs
-            - listener?: Process messages during this rpc (DdbMessage)
-            - parse_object?: Set parse_object during this rpc, and restore the original after the end.
+        - script?: 执行的脚本  Script to execute
+        - options?: 执行选项  execution options
+            - urgent?: 紧急 flag，确保提交的脚本使用 urgent worker 处理，防止被其它作业阻塞
+                Urgent flag to ensure that submitted scripts are processed by urgent workers to prevent being blocked by other jobs
+            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)
+                Process messages during this rpc (DdbMessage)
+            - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
+                不做解析，以便后续转发、序列化
+                Set parse_object during this rpc, and restore the original after the end.
                 When it is false, the returned DdbObj only contains buffer and le without parsing,
                 so as to facilitate subsequent forwarding and serialization
     */
@@ -568,16 +579,24 @@ export declare class DDB {
         parse_object?: boolean;
     }): Promise<T>;
     /** call function through websocket (function command)
-        - func: function name
-        - args?: `[ ]` Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
-        - options?: call options
-            - urgent?: Emergency flag. Use urgent worker execution to prevent being blocked by other jobs
-            - node?: When the node alias is set, it is sent to the corresponding node in the cluster for execution (using the rpc method in DolphinDB)
-            - nodes?: When setting multiple node aliases, send them to the corresponding multiple nodes in the cluster for execution (using the pnodeRun method in DolphinDB)
-            - func_type?: It must be passed when setting the node parameter, the function type needs to be specified, and it is not passed in other cases
-            - add_node_alias?: Select to pass when setting the nodes parameter, otherwise not pass
-            - listener?: Process messages during this rpc (DdbMessage)
-            - parse_object?: Set parse_object during this rpc, and restore the original after the end.
+        - func: 函数名  function name
+        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)  Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
+        - options?: 调用选项  call options
+            - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
+                Emergency flag. Use urgent worker execution to prevent being blocked by other jobs
+            - node?: 设置结点 alias 时发送到集群中对应的结点执行 (使用 DolphinDB 中的 rpc 方法)
+                When the node alias is set, it is sent to the corresponding node in the cluster for execution (using the rpc method in DolphinDB)
+            - nodes?: 设置多个结点 alias 时发送到集群中对应的多个结点执行 (使用 DolphinDB 中的 pnodeRun 方法)
+                When setting multiple node aliases, send them to the corresponding multiple nodes in the cluster for execution (using the pnodeRun method in DolphinDB)
+            - func_type?: 设置 node 参数时必传，需指定函数类型，其它情况下不传
+                It must be passed when setting the node parameter, the function type needs to be specified, and it is not passed in other cases
+            - add_node_alias?: 设置 nodes 参数时选传，其它情况不传
+                Select to pass when setting the nodes parameter, otherwise not pass
+            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)
+                Process messages during this rpc (DdbMessage)
+            - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
+                不做解析，以便后续转发、序列化
+                Set parse_object during this rpc, and restore the original after the end.
                 When it is false, the returned DdbObj only contains buffer and le without parsing,
                 so as to facilitate subsequent forwarding and serialization
     */
@@ -592,18 +611,18 @@ export declare class DDB {
     }): Promise<T>;
     /** upload variable through websocket (variable command) */
     upload(
-    /** Uploaded variables' name */
+    /** 上传的变量名  Uploaded variables' name */
     vars: string[], 
-    /** Uploaded variables' value */
+    /** 上传的变量值  Uploaded variables' value */
     args: (DdbObj | string | boolean)[], { listener, parse_object, }?: {
         listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<DdbObj<DdbValue>>;
-    /** Cancel all console jobs corresponding to the current session id */
+    /** 取消当前 session id 对应的所有 console jobs  Cancel all console jobs corresponding to the current session id */
     cancel(): Promise<void>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
-    /** Internal stream subscription method */
+    /** 内部的流订阅方法  Internal stream subscription method */
     subscribe(): Promise<StreamingData>;
 }
 export interface DdbMessageListener {