dolphindb 2.0.505 → 2.0.508

package/index.d.ts

@@ -78,7 +78,12 @@ export interface DdbArrayVectorBlock {
     lengths: Uint8Array | Uint16Array | Uint32Array;
     data: DdbVectorValue;
 }
-export declare type DdbValue = null | boolean | number | [number, number] | bigint | string | string[] | Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbFunctionDefValue | DdbSymbolExtendedValue | DdbArrayVectorBlock[];
+export interface DdbMatrixValue {
+    rows: DdbObj;
+    cols: DdbObj;
+    data: DdbVectorValue;
+}
+export declare type DdbValue = null | boolean | number | [number, number] | bigint | string | string[] | Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbFunctionDefValue | DdbSymbolExtendedValue | DdbArrayVectorBlock[] | DdbMatrixValue;
 export declare type DdbVectorValue = string | string[] | Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbSymbolExtendedValue | DdbArrayVectorBlock[];
 export declare const nulls: {
     readonly int8: -128;
@@ -123,23 +128,20 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     rows?: number;
     /** 第 2 维 */
     cols?: number;
-    /** matrix 中值的类型，仅 matrix 才有 */
-    datatype?: DdbType;
     /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据 */
     value: T;
-    /** 原始二进制数据 */
+    /** 原始二进制数据，仅在 parse_object 为 false 时通过 parse_message 生成的顶层对象有这个属性 */
     buffer?: Uint8Array;
     constructor(data: Partial<DdbObj> & {
         form: DdbForm;
         type: DdbType;
-        length: number;
     });
     static parse(buf: Uint8Array, le: boolean): DdbObj<DdbValue>;
     static parse_scalar(buf: Uint8Array, le: boolean, type: DdbType): [number, DdbValue];
     /** parse: rows, cols, items
         返回的 ddbobj.length 不包括 vector 的 type 和 form
     */
-    static parse_vector(buf: Uint8Array, le: boolean, type: DdbType): DdbObj;
+    static parse_vector(buf: Uint8Array, le: boolean, type: DdbType): DdbObj<DdbVectorValue>;
     /** 有可能没有字节对齐，不能直接使用原有 message 的 arraybuffer, 统一复制出来，让原有 arraybuffer 被回收掉比较好 */
     static parse_vector_items(buf: Uint8Array, le: boolean, type: DdbType, length: number): [
         number,
@@ -252,7 +254,6 @@ export declare class DDB {
     /** utf-8 text decoder */
     dec: TextDecoder;
     enc: TextEncoder;
-    print_buffer: boolean;
     /** DolphinDB WebSocket URL
         e.g. `ws://127.0.0.1:8848/`, `wss://dolphindb.com`
     */
@@ -270,13 +271,13 @@ export declare class DDB {
     password: string;
     /** python session flag (2048) */
     python: boolean;
+    print_message_buffer: boolean;
+    print_object_buffer: boolean;
+    print_message: boolean;
     parse_object: boolean;
-    /** message handler */
-    on_message({ type, data }: DdbMessage, _this: DDB): void;
-    /** resolver, rejector, promise of last rpc */
-    presolver(message: DdbMessage): void;
-    prejector(error: Error): void;
-    presult: Promise<DdbMessage>;
+    /** DdbMessage listeners */
+    listeners: DdbMessageListener[];
+    promise: Promise<any>;
     get connected(): boolean;
     /**
         Initialize an instance of DolphinDB Client using the WebSocket URL
@@ -305,6 +306,7 @@ export declare class DDB {
         password?: string;
         python?: boolean;
     });
+    private on_message;
     /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL
         - options?:
             - url?: DolphinDB WebSocket URL. By default, the WebSocket URL passed in when the instance is initialized is used
@@ -349,52 +351,54 @@ export declare class DDB {
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
             - vars?: type === 'variable' 时必传，variable 指令中待上传的变量名
-            - on_message?:   在该次 rpc 期间设置 message handler, 结束后恢复原有
+            - handler?: Process messages during this rpc (DdbMessage)
             - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
                 不做解析，以便后续转发、序列化
     */
-    rpc<T extends DdbObj = DdbObj>(type: 'script' | 'function' | 'variable' | 'connect', { script, func, args, vars, urgent, on_message, parse_object, }: {
+    rpc<T extends DdbObj = DdbObj>(type: 'script' | 'function' | 'variable' | 'connect', { script, func, args, vars, urgent, listener, parse_object, }: {
         script?: string;
         func?: string;
         args?: (DdbObj | string | boolean)[];
         vars?: string[];
         urgent?: boolean;
-        on_message?: DDB['on_message'];
+        listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<T>;
     /** eval script through websocket (script command)
-        - script?: 执行的脚本
-        - options?: 执行选项
-            - urgent?: 紧急 flag，确保提交的脚本使用 urgent worker 处理，防止被其它作业阻塞
-            - on_message?: 在该次 rpc 期间设置 message handler, 结束后恢复原有
-            - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
-                不做解析，以便后续转发、序列化
+        - 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.
+                When it is false, the returned DdbObj only contains buffer and le without parsing,
+                so as to facilitate subsequent forwarding and serialization
     */
-    eval<T extends DdbObj>(script: string, { urgent, on_message, parse_object, }?: {
+    eval<T extends DdbObj>(script: string, { urgent, listener, parse_object, }?: {
         urgent?: boolean;
-        on_message?: DDB['on_message'];
+        listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<T>;
     /** call function through websocket (function command)
-        - func: 函数名
-        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
-        - options?: 调用选项
-            - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
-            - node?: 设置结点 alias 时发送到集群中对应的结点执行 (使用 DolphinDB 中的 rpc 方法)
-            - nodes?: 设置多个结点 alias 时发送到集群中对应的多个结点执行 (使用 DolphinDB 中的 pnodeRun 方法)
-            - func_type?: 设置 node 参数时必传，需指定函数类型，其它情况下不传
-            - add_node_alias?: 设置 nodes 参数时选传，其它情况不传
-            - on_message?: 在该次 rpc 期间设置 message handler, 结束后恢复原有
-            - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
-                不做解析，以便后续转发、序列化
+        - 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.
+                When it is false, the returned DdbObj only contains buffer and le without parsing,
+                so as to facilitate subsequent forwarding and serialization
     */
-    call<T extends DdbObj>(func: string, args?: (DdbObj | string | boolean)[], { urgent, node, nodes, func_type, add_node_alias, on_message, parse_object, }?: {
+    call<T extends DdbObj>(func: string, args?: (DdbObj | string | boolean)[], { urgent, node, nodes, func_type, add_node_alias, listener, parse_object, }?: {
         urgent?: boolean;
         node?: string;
         nodes?: string[];
         func_type?: DdbFunctionType;
         add_node_alias?: boolean;
-        on_message?: DDB['on_message'];
+        listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<T>;
     /** upload variable through websocket (variable command) */
@@ -402,8 +406,8 @@ export declare class DDB {
     /** Uploaded variables' name */
     vars: string[], 
     /** Uploaded variables' value */
-    args: (DdbObj | string | boolean)[], { on_message, parse_object, }?: {
-        on_message?: DDB['on_message'];
+    args: (DdbObj | string | boolean)[], { listener, parse_object, }?: {
+        listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<DdbObj<DdbValue>>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
@@ -413,6 +417,9 @@ export declare class DDB {
     /** 转换 js 数组为 DdbObj[] */
     to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
 }
+export interface DdbMessageListener {
+    (message: DdbMessage, _this: DDB): any;
+}
 export interface DdbPrintMessage {
     type: 'print';
     data: string;
@@ -421,5 +428,9 @@ export interface DdbObjectMessage {
     type: 'object';
     data: DdbObj;
 }
-export declare type DdbMessage = DdbPrintMessage | DdbObjectMessage;
+export interface DdbErrorMessage {
+    type: 'error';
+    data: Error;
+}
+export declare type DdbMessage = DdbPrintMessage | DdbObjectMessage | DdbErrorMessage;
 export default DDB;