dolphindb 2.0.921 → 2.0.923

package/browser.d.ts

@@ -0,0 +1,667 @@
+import 'xshell/prototype.browser.js';
+export declare enum DdbForm {
+    scalar = 0,
+    vector = 1,
+    pair = 2,
+    matrix = 3,
+    set = 4,
+    dict = 5,
+    table = 6,
+    chart = 7,
+    /** 结点内部通信可能会使用，调用函数执行脚本一般不会返回这种类型
+        Node internal communication may be used, calling function execution script generally does not return this type */
+    chunk = 8,
+    /** sysobj */
+    object = 9
+}
+/** DolphinDB DataType
+    对应的 array vector 类型为 64 + 基本类型  The corresponding array vector type is 64 + base type
+    对应的 extended 类型为 128 + 基本类型  The corresponding extended type is 128 + base type
+*/
+export declare enum DdbType {
+    void = 0,
+    bool = 1,
+    char = 2,
+    short = 3,
+    int = 4,
+    long = 5,
+    date = 6,
+    month = 7,
+    time = 8,
+    minute = 9,
+    second = 10,
+    datetime = 11,
+    timestamp = 12,
+    nanotime = 13,
+    nanotimestamp = 14,
+    float = 15,
+    double = 16,
+    symbol = 17,
+    string = 18,
+    uuid = 19,
+    functiondef = 20,
+    handle = 21,
+    code = 22,
+    datasource = 23,
+    resource = 24,
+    any = 25,
+    compress = 26,
+    dict = 27,
+    datehour = 28,
+    ipaddr = 30,
+    int128 = 31,
+    blob = 32,
+    complex = 34,
+    point = 35,
+    duration = 36,
+    decimal32 = 37,
+    decimal64 = 38,
+    decimal128 = 39,
+    object = 40,
+    pynone = 41,
+    symbol_extended = 145
+}
+export declare enum DdbFunctionType {
+    SystemFunc = 0,
+    SystemProc = 1,
+    OperatorFunc = 2,
+    UserDefinedFunc = 3,
+    PartialFunc = 4,
+    DynamicFunc = 5,
+    PiecewiseFunc = 6,
+    JitFunc = 7,
+    JitPartialFunc = 8
+}
+export declare enum DdbDurationUnit {
+    ns = 0,
+    us = 1,
+    ms = 2,
+    s = 3,
+    m = 4,
+    H = 5,
+    d = 6,
+    w = 7,
+    M = 8,
+    y = 9,
+    B = 10
+}
+export interface DdbFunctionDefValue {
+    type: DdbFunctionType;
+    name: string;
+}
+export interface DdbDurationValue {
+    unit: DdbDurationUnit;
+    /** int32 */
+    data: number;
+}
+export interface DdbDecimal32Value {
+    /** int32, data 需要除以 10^scale 得到原值  data needs to be divided by 10^scale to get the original value */
+    scale: number;
+    /** int32, 空值为 null  ddb null is js null */
+    data: number | null;
+}
+export interface DdbDecimal64Value {
+    /** int32, data 需要除以 10^scale 得到原值  data needs to be divided by 10^scale to get the original value */
+    scale: number;
+    /** int64, 空值为 null  empty value is null */
+    data: bigint | null;
+}
+export interface DdbDecimal32VectorValue {
+    scale: number;
+    data: Int32Array;
+}
+export interface DdbDecimal64VectorValue {
+    scale: number;
+    data: BigInt64Array;
+}
+export interface DdbSymbolExtendedValue {
+    base_id: number;
+    base: string[];
+    data: Uint32Array;
+}
+export interface DdbArrayVectorBlock {
+    unit: 1 | 2 | 4;
+    rows: number;
+    lengths: Uint8Array | Uint16Array | Uint32Array;
+    data: Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array;
+}
+export type DdbArrayVectorValue = DdbArrayVectorBlock[] & /* decimal32, decimal64 会有这个属性 */ {
+    scale?: number;
+};
+export interface DdbMatrixValue {
+    rows: DdbVectorObj;
+    cols: DdbVectorObj;
+    data: DdbVectorValue;
+}
+export type DdbDictValue = [DdbVectorObj, DdbVectorObj];
+export declare enum DdbChartType {
+    area = 0,
+    bar = 1,
+    column = 2,
+    histogram = 3,
+    line = 4,
+    pie = 5,
+    scatter = 6,
+    trend = 7,
+    kline = 8
+}
+export interface DdbChartValue {
+    /** 原属性 chartType  original: chartType */
+    type: DdbChartType;
+    stacking: boolean;
+    /** 直方图 (Histogram), plotHist 函数返回的 chart 可能具有该属性
+        原属性 binStart
+        数值类型的 DdbObj 都有可能？
+    */
+    bin_start?: DdbObj;
+    /** 原属性 binEnd */
+    bin_end?: DdbObj;
+    /** 原属性 binCount */
+    bin_count?: DdbObj;
+    titles: {
+        chart: string;
+        x_axis: string;
+        y_axis: string;
+    };
+    extras?: {
+        multi_y_axes: boolean;
+    };
+    data: DdbMatrixObj;
+}
+export type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
+[
+    number,
+    number
+] | // complex, point
+DdbFunctionDefValue | DdbDurationValue | DdbDecimal32Value | DdbDecimal64Value;
+export type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
+Uint8Array[] | // blob
+DdbObj[] | // any
+DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDecimal64VectorValue;
+export type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
+export type DdbStringObj = DdbObj<string>;
+export type DdbVectorObj = DdbObj<DdbVectorValue>;
+export type DdbVectorAnyObj = DdbObj<DdbObj[]>;
+export type DdbVectorStringObj = DdbObj<string[]>;
+export type DdbTableObj = DdbObj<DdbVectorObj[]>;
+export type DdbDictObj = DdbObj<[DdbVectorObj, DdbVectorObj]>;
+export type DdbMatrixObj = DdbObj<DdbMatrixValue>;
+export type DdbChartObj = DdbObj<DdbChartValue>;
+export declare const nulls: {
+    readonly int8: -128;
+    readonly int16: -32768;
+    readonly int32: -2147483648;
+    readonly int64: -9223372036854775808n;
+    readonly float32: -3.4028234663852886e+38;
+    /** -Number.MAX_VALUE */
+    readonly double: number;
+    readonly bytes16: Uint8Array;
+};
+/** 可以表示所有 DolphinDB 数据库中的数据类型  Can represent data types in all DolphinDB databases */
+export declare class DdbObj<TValue extends DdbValue = DdbValue> {
+    static dec: TextDecoder;
+    static enc: TextEncoder;
+    /** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base ？
+        只是暂存，如果一张表有多个 symbol 列，可能这个 symbol base 会被复用，不同的对象之间 symbol base 一般不复用
+    */
+    static symbol_bases: Record<number, string[]>;
+    /** little endian (client) */
+    static le_client: boolean;
+    /** 是否为小端 (little endian) */
+    le: boolean;
+    /** 数据形式 https://www.dolphindb.cn/cn/help/DataTypesandStructures/DataForms/index.html */
+    form: DdbForm;
+    /** 数据类型 https://www.dolphindb.cn/cn/help/DataTypesandStructures/DataTypes/index.html */
+    type: DdbType;
+    /** 占用 parse 时传入的 buf 的长度 */
+    length: number;
+    /** table name / column name */
+    name?: string;
+    /**
+        最低维、第 1 维
+        - vector: rows = n, cols = 1
+        - pair:   rows = 2, cols = 1
+        - matrix: rows = n, cols = m
+        - set:    同 vector
+        - dict:   包含 keys, values 向量
+        - table:  同 matrix
+    */
+    rows?: number;
+    /** 第 2 维 */
+    cols?: number;
+    /** 实际数据。不同的 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;
+    constructor(data: Partial<DdbObj> & {
+        form: DdbForm;
+        type: DdbType;
+    });
+    static parse(buf: Uint8Array, le: boolean): DdbObj<DdbValue>;
+    static parse_scalar(buf: Uint8Array, le: boolean, type: DdbType): [number, DdbScalarValue];
+    /** parse: rows, cols, items
+        返回的 ddbobj.length 不包括 vector 的 type 和 form
+    */
+    static parse_vector(buf: Uint8Array, le: boolean, type: DdbType): DdbVectorObj;
+    /** 有可能没有字节对齐，不能直接使用原有 message 的 arraybuffer, 统一复制出来，让原有 arraybuffer 被回收掉比较好 */
+    static parse_vector_items(buf: Uint8Array, le: boolean, type: DdbType, length: number): [
+        number,
+        DdbVectorValue
+    ];
+    pack(): Uint8Array;
+    static pack_vector_body(value: DdbVectorValue, type: DdbType, length: number): ArrayBufferView[];
+    toString(options?: InspectOptions): string;
+    inspect_type(): string;
+    /** 自动转换 js string, boolean 为 DdbObj */
+    static to_ddbobj(value: DdbObj | string | boolean): DdbObj;
+    /** 转换 js 数组为 DdbObj[] */
+    static to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
+    to_cols(): {
+        title: string;
+        dataIndex: string;
+        render: (value: any) => string;
+    }[];
+    to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
+    /** 将 dict<string, any> 自动转换为 js object (Record<string, any>)  Automatically convert dict<string, any> to js object (Record<string, any>)
+        - options?:
+            - 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: {
+        strip: true;
+    }): T;
+    to_dict<T extends Record<string, any> = Record<string, any>>(options?: {
+        strip?: boolean;
+        deep?: boolean;
+    }): T;
+}
+export interface InspectOptions {
+    colors?: boolean;
+    /** `null` decimal places 小数位数 */
+    decimals?: number;
+    /** `false` 决定 null 值如何返回. nullstr ? 'null' : '' */
+    nullstr?: boolean;
+    /** `false` 决定 string, symbol, char 类型是否加引号 */
+    quote?: boolean;
+}
+/** 根据 DdbType 格式化单个元素 (value) 为字符串  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;
+/** 格式化向量、集合中的第 index 项为字符串  formatted vector, the index-th item in the collection is a string */
+export declare function formati(obj: DdbVectorObj, index: number, options?: InspectOptions): string;
+export declare class DdbVoid extends DdbObj<undefined> {
+    constructor();
+}
+export declare class DdbBool extends DdbObj<boolean> {
+    constructor(value: boolean | null);
+}
+export declare class DdbChar extends DdbObj<string> {
+    constructor(value: string | number | null);
+}
+export declare class DdbInt extends DdbObj<number> {
+    constructor(value: number | null);
+}
+export declare class DdbString extends DdbObj<string> {
+    constructor(value: string);
+}
+export declare class DdbLong extends DdbObj<bigint> {
+    constructor(value: bigint | null);
+}
+export declare class DdbDouble extends DdbObj<number> {
+    constructor(value: number | null);
+}
+export declare class DdbDateTime extends DdbObj<number> {
+    constructor(value: number | null);
+}
+export declare class DdbTimeStamp extends DdbObj<bigint> {
+    constructor(value: bigint | null);
+}
+export declare class DdbNanoTimeStamp extends DdbObj<bigint> {
+    constructor(value: bigint | null);
+}
+export declare class DdbPair extends DdbObj<Int32Array> {
+    constructor(l: number | null, r?: number | null);
+}
+export declare class DdbFunction extends DdbObj<DdbFunctionDefValue> {
+    constructor(name: string, type: DdbFunctionType);
+}
+export declare class DdbVectorInt extends DdbObj<Int32Array> {
+    constructor(ints: (number | null)[] | Int32Array, name?: string);
+}
+export declare class DdbVectorDouble extends DdbObj<Float64Array> {
+    constructor(doubles: (number | null)[] | Float64Array, name?: string);
+}
+export declare class DdbVectorString extends DdbObj<string[]> {
+    constructor(strings: string[], name?: string);
+}
+export declare class DdbVectorAny extends DdbObj {
+    constructor(objs: (DdbObj | string | boolean)[], name?: string);
+}
+export declare class DdbVectorSymbol extends DdbObj<DdbSymbolExtendedValue> {
+    constructor(strings: string[], name?: string);
+}
+export declare class DdbSetInt extends DdbObj<Int32Array> {
+    constructor(ints: (number | null)[] | Set<number> | Int32Array);
+}
+export declare class DdbSetDouble extends DdbObj<Float64Array> {
+    constructor(doubles: (number | null)[] | Set<number> | Float64Array);
+}
+export declare class DdbSetString extends DdbObj<string[]> {
+    constructor(strings: string[] | Set<string>);
+}
+/** 构造 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);
+}
+export declare class DdbTable extends DdbObj<DdbObj[]> {
+    constructor(columns: DdbObj[], name?: string);
+}
+export declare function date2ms(date: number | null): number;
+export declare function date2str(date: number | null, format?: string): string;
+export declare function month2ms(month: number | null): number | null;
+export declare function month2str(month: number | null): string;
+export declare function time2ms(time: number | null): number | null;
+export declare function time2str(time: number | null, format?: string): string;
+export declare function minute2ms(minute: number | null): number | null;
+export declare function minute2str(minute: number | null, format?: string): string;
+export declare function second2ms(second: number | null): number | null;
+export declare function second2str(second: number | null, format?: string): string;
+export declare function datetime2ms(datetime: number | null): number | null;
+export declare function datetime2str(datetime: number | null, format?: string): string;
+export declare function timestamp2ms(timestamp: bigint | null): number | null;
+/** format timestamp (bigint) to string
+    - timestamp: bigint value
+    - format?:
+        格式串，默认是 `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, 如果为空字符串或 '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
+*/
+export declare function str2timestamp(str: string, format?: string): bigint;
+export declare function nanotime2ns(nanotime: bigint | null): bigint | null;
+export declare function nanotime2str(nanotime: bigint | null, format?: string): string;
+export declare function nanotimestamp2ns(nanotimestamp: bigint | null): bigint | null;
+/** format nanotimestamp value (bigint) to string
+    - nanotimestamp: bigint value
+    - format?:
+        格式串，默认是 `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, 如果为空字符串或 'null' 会返回对应的空值 (nulls.int64)
+        nano 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.SSSSSSSSS`
+        秒的格式为 ss (必须包含); 纳秒的格式为 SSSSSSSSS (必须包含)
+        https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
+        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) */
+export declare function str2nanotimestamp(str: string, format?: string): bigint;
+export declare function ipaddr2str(buffer: Uint8Array, le?: boolean, ipv6?: boolean): string;
+export declare function uuid2str(buffer: Uint8Array, le?: boolean): string;
+export declare function int1282str(buffer: Uint8Array, le?: boolean): string;
+export interface StreamingParams {
+    table: string;
+    action?: string;
+    handler(message: StreamingData): any;
+}
+export interface StreamingData extends StreamingParams {
+    /** 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.
+        它是一个字符串，由订阅表所在节点的别名、流数据表名称和订阅任务名称（如果指定了 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;
+    /** 流数据，类型是 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 */
+    rows: number;
+    window: {
+        /** 建立连接开始 offset = 0, 随着 window 的移动逐渐增加  The establishment of the connection starts offset = 0, and gradually increases as the window moves */
+        offset: number;
+        /** segments 中 segment.row 的总和  sum of segment.row in segments */
+        rows: number;
+        /** 每次接收到的 data 组成的数组  An array of data received each time */
+        segments: DdbObj<DdbVectorObj[]>[];
+    };
+    /** 成功订阅后，后续推送过来的 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;
+type DdbRpcType = 'script' | 'function' | 'variable' | 'connect';
+export interface DdbRpcOptions {
+    script?: string;
+    func?: string;
+    args?: (DdbObj | string | boolean)[];
+    vars?: string[];
+    urgent?: boolean;
+    listener?: DdbMessageListener;
+    parse_object?: boolean;
+}
+export declare class DdbConnectionError extends Error {
+    name: string;
+    ddb: DDB;
+    constructor(ddb: DDB, error_options?: ErrorOptions);
+}
+export declare class DdbDatabaseError extends Error {
+    name: string;
+    ddb: DDB;
+    type: DdbRpcType;
+    options: DdbRpcOptions;
+    constructor(message: string, ddb: DDB, type: DdbRpcType, options: DdbRpcOptions);
+}
+export declare class DDB {
+    /** 当前的 session id (http 或 tcp) */
+    sid: string;
+    /** utf-8 text decoder */
+    dec: TextDecoder;
+    enc: TextEncoder;
+    /** DolphinDB WebSocket URL
+        e.g. `ws://127.0.0.1:8848/`, `wss://dolphindb.com`
+    */
+    url: string;
+    websocket: WebSocket;
+    /** little endian (server) */
+    le: boolean;
+    /** little endian (client) */
+    static le_client: boolean;
+    /** 是否在建立连接后自动登录，默认 true  Whether to automatically log in after the connection is established, the default is true */
+    autologin: boolean;
+    /** DolphinDB 登录用户名  DolphinDB username */
+    username: string;
+    /** DolphinDB 登录密码  DolphinDB password */
+    password: string;
+    /** python session flag (2048) */
+    python: boolean;
+    /** 是否为流数据连接，非流数据这个字段恒为 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;
+    print_message: boolean;
+    parse_object: boolean;
+    pnode_run_defined: boolean;
+    /** DdbMessage listeners */
+    listeners: DdbMessageListener[];
+    pconnect: Promise<void>;
+    ppnoderun: Promise<void>;
+    presult: Promise<any>;
+    get connected(): boolean;
+    /**
+        使用 WebSocket URL 初始化连接到 DolphinDB 的实例（不建立实际的网络连接）
+        Initialize an instance of DolphinDB Client using the WebSocket URL (without establishing an actual network connection)
+        - url?: DolphinDB WebSocket URL，如：`ws://127.0.0.1:8848`, 默认为当前页面 URL
+            DolphinDB WebSocket URL. e.g.：`ws://127.0.0.1:8848`, Defaults to the current page URL
+        - options?:
+            - 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')
+        
+        // 使用 HTTPS 加密  Encrypt with HTTPS
+        let ddbsecure = new DDB('wss://dolphindb.com', {
+            autologin: true,
+            username: 'admin',
+            password: '123456',
+            python: false
+        })
+    */
+    constructor(url?: string, options?: {
+        autologin?: boolean;
+        username?: string;
+        password?: string;
+        python?: boolean;
+        streaming?: StreamingParams;
+    });
+    private on_message;
+    /** 建立实际的 WebSocket 连接到 URL 对应的 DolphinDB  Establish a actual websocket connection to the DolphindB corresponding to the URL
+        是幂等的，调用后会确保已连接到数据库 (确保 websocket.readyState 为 open)，否则报错  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;
+        /** API 提交的任务, secondary 必须为 false */
+        secondary?: boolean;
+        /** 是否异步任务（不返回结果） */
+        async?: boolean;
+        /** 让服务端以 pickle 协议返回数据 */
+        pickle?: boolean;
+        /** 本次任务完成后 clear session memory */
+        clear?: boolean;
+        /** 是否为 api client */
+        api?: boolean;
+        compress?: boolean;
+        /** 任务是否可以取消 */
+        cancellable?: boolean;
+        priority?: number;
+        /** `8` 0 ~ 64, 指定本任务并行度 */
+        parallelism?: number;
+        /** 根任务编号，内部使用，API中固定为空 */
+        root_id?: string;
+        /** 指定分块返回的块大小 */
+        limit?: boolean;
+    }): string;
+    disconnect(): void;
+    /** rpc through websocket (function/script/variable command)
+        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 DdbConnectionError
+        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the DdbConnectionError
+        - type: API 类型: 'script' | 'function' | 'variable'
+        - options:
+            - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
+            - vars?: type === 'variable' 时必传，variable 指令中待上传的变量名
+            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)
+            - parse_object?: 在本次 rpc 期间设置 parse_object, 结束后恢复原有
+                为 false 时返回的 DdbObj 仅含有 buffer 和 le，不做解析，以便后续转发、序列化
+    */
+    rpc<T extends DdbObj = DdbObj>(type: DdbRpcType, options: DdbRpcOptions): Promise<T>;
+    /** eval script through websocket (script command)
+        - 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
+    */
+    eval<T extends DdbObj>(script: string, { urgent, listener, parse_object, }?: {
+        urgent?: boolean;
+        listener?: DdbMessageListener;
+        parse_object?: boolean;
+    }): Promise<T>;
+    /** call function through websocket (function command)
+        - 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
+    */
+    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;
+        listener?: DdbMessageListener;
+        parse_object?: boolean;
+    }): Promise<T>;
+    /** upload variable through websocket (variable command) */
+    upload(
+    /** 上传的变量名  Uploaded variables' name */
+    vars: string[], 
+    /** 上传的变量值  Uploaded variables' value */
+    args: (DdbObj | string | boolean)[], { listener, parse_object, }?: {
+        listener?: DdbMessageListener;
+        parse_object?: boolean;
+    }): Promise<DdbObj<DdbValue>>;
+    /** 取消当前 session id 对应的所有 console jobs  Cancel all console jobs corresponding to the current session id */
+    cancel(): Promise<void>;
+    /** 解析服务端响应报文，返回去掉 header 的 data buf */
+    parse_message(buf: Uint8Array, error: DdbDatabaseError): DdbMessage;
+    /** 内部的流订阅方法  Internal stream subscription method */
+    subscribe(): Promise<StreamingData>;
+}
+export interface DdbMessageListener {
+    (message: DdbMessage, _this: DDB): any;
+}
+export interface DdbPrintMessage {
+    type: 'print';
+    data: string;
+}
+export interface DdbObjectMessage {
+    type: 'object';
+    data: DdbObj;
+}
+export interface DdbErrorMessage {
+    type: 'error';
+    data: Error;
+}
+export type DdbMessage = DdbPrintMessage | DdbObjectMessage | DdbErrorMessage;
+export declare let ddb: DDB;
+export {};