dolphindb 2.0.518 → 2.0.521

package/index.d.ts

@@ -10,6 +10,7 @@ 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 */
     chunk = 8,
     /** sysobj */
     object = 9
@@ -106,6 +107,33 @@ export interface DdbMatrixValue {
     cols: DdbObj<DdbVectorValue>;
     data: DdbVectorValue;
 }
+export declare type DdbDictValue = [DdbObj<DdbVectorValue>, DdbObj<DdbVectorValue>];
+export declare enum DdbChartType {
+    area = 0,
+    bar = 1,
+    column = 2,
+    histogram = 3,
+    line = 4,
+    pie = 5,
+    scatter = 6,
+    trend = 7,
+    kline = 8,
+    stack = 9
+}
+export interface DdbChartValue {
+    /** original: chartType */
+    type: DdbChartType;
+    stacking: boolean;
+    titles: {
+        chart: string;
+        x_axis: string;
+        y_axis: string;
+    };
+    extras: {
+        multi_y_axis: boolean;
+    };
+    data: DdbObj<DdbMatrixValue>;
+}
 export declare type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
 [
     number,
@@ -116,7 +144,7 @@ export declare type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32
 Uint8Array[] | // blob
 DdbObj[] | // any
 DdbSymbolExtendedValue | DdbArrayVectorBlock[];
-export declare type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue;
+export declare type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
 export declare const nulls: {
     readonly int8: -128;
     readonly int16: -32768;
@@ -182,8 +210,24 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     pack(): Uint8Array;
     static pack_vector_body(value: DdbVectorValue, type: DdbType, length: number): ArrayBufferView[];
     [inspect.custom](depth: number, options: InspectOptions, _inspect: any): string;
+    /** 自动转换 js string, boolean 为 DdbObj */
+    static to_ddbobj(value: DdbObj | string | boolean): DdbObj;
+    /** 转换 js 数组为 DdbObj[] */
+    static to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
-    to_dict<T = Record<string, any>>(): T;
+    /** 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
+    */
+    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 declare function format(type: DdbType, value: DdbValue, le: boolean, options: InspectOptions): string;
 export declare class DdbVoid extends DdbObj<undefined> {
@@ -232,7 +276,7 @@ export declare class DdbVectorString extends DdbObj<string[]> {
     constructor(strings: string[], name?: string);
 }
 export declare class DdbVectorAny extends DdbObj {
-    constructor(objs: DdbObj<DdbValue>[], name?: string);
+    constructor(objs: (DdbObj | string | boolean)[], name?: string);
 }
 export declare class DdbVectorSymbol extends DdbObj<DdbSymbolExtendedValue> {
     constructor(strings: string[], name?: string);
@@ -246,23 +290,39 @@ 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>
+*/
+export declare class DdbDict extends DdbObj<DdbDictValue> {
+    constructor(obj: Record<string, boolean | string | DdbObj>);
+    constructor(keys: DdbObj<DdbVectorValue>, values: DdbObj<DdbVectorValue>);
+}
 export declare class DdbTable extends DdbObj<DdbObj[]> {
     constructor(columns: DdbObj[], name?: string);
 }
-export declare function date2str(date: number, format?: string): 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 time2str(time: number, format?: string): 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 datetime2str(datetime: number, 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?:
         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, format?: string): string;
-export declare function datehour2str(datehour: number, format?: string): string;
+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)
     - format?:
@@ -270,7 +330,9 @@ export declare function datehour2str(datehour: number, format?: string): string;
         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 nanotime2str(nanotime: bigint, format?: string): string;
+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?:
@@ -278,7 +340,7 @@ export declare function nanotime2str(nanotime: bigint, format?: string): string;
         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, format?: string): string;
+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)
     - format?:
@@ -454,10 +516,6 @@ export declare class DDB {
     }): Promise<DdbObj<DdbValue>>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
-    /** 自动转换 js string, boolean 为 DdbObj */
-    to_ddbobj(value: DdbObj | string | boolean): DdbObj;
-    /** 转换 js 数组为 DdbObj[] */
-    to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
 }
 export interface DdbMessageListener {
     (message: DdbMessage, _this: DDB): any;