dolphindb 3.0.224 → 3.0.227

package/common.d.ts

@@ -0,0 +1,300 @@
+import { type Dayjs } from 'dayjs';
+import 'xshell/prototype.common.js';
+export declare const nulls: {
+    readonly int8: -128;
+    readonly int16: -32768;
+    readonly int32: -2147483648;
+    readonly int64: -9223372036854775808n;
+    readonly int128: -170141183460469231731687303715884105728n;
+    readonly float32: -3.4028234663852886e+38;
+    /** -Number.MAX_VALUE */
+    readonly double: number;
+    readonly bytes16: Uint8Array<ArrayBuffer>;
+};
+export declare enum DdbForm {
+    scalar = 0,
+    vector = 1,
+    pair = 2,
+    matrix = 3,
+    set = 4,
+    dict = 5,
+    table = 6,
+    chart = 7,
+    /** 节点内部通信可能会使用，调用函数执行脚本一般不会返回这种类型 */
+    chunk = 8,
+    /** sysobj */
+    object = 9,
+    tensor = 10
+}
+/** DolphinDB DataType
+    对应的 array vector 类型为 64 + 基本类型
+    对应的 extended 类型为 128 + 基本类型 */
+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,
+    compressed = 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,
+    iotany = 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 declare enum DdbChartType {
+    area = 0,
+    bar = 1,
+    column = 2,
+    histogram = 3,
+    line = 4,
+    pie = 5,
+    scatter = 6,
+    trend = 7,
+    kline = 8
+}
+export declare enum DdbVoidType {
+    undefined = 0,
+    null = 1,
+    default = 2
+}
+export interface DdbFunctionDefValue {
+    type: DdbFunctionType;
+    name: string;
+}
+export interface DdbDurationValue {
+    unit: DdbDurationUnit;
+    /** int32 */
+    data: number;
+}
+export interface DdbDecimal32Value {
+    /** int32, data 需要除以 10^scale 得到原值 */
+    scale: number;
+    /** int32, 空值为 null  ddb null is js null */
+    data: number | null;
+}
+export interface DdbDecimal64Value {
+    /** int32, data 需要除以 10^scale 得到原值 */
+    scale: number;
+    /** int64, 空值为 null  empty value is null */
+    data: bigint | null;
+}
+export interface DdbDecimal128Value {
+    /** int32, data 需要除以 10^scale 得到原值 */
+    scale: number;
+    /** int128, 空值为 null  empty value is null */
+    data: bigint | null;
+}
+export interface DdbDecimal32VectorValue {
+    scale: number;
+    data: Int32Array;
+}
+export interface DdbDecimal64VectorValue {
+    scale: number;
+    data: BigInt64Array;
+}
+export type DdbDurationVectorValue = DdbDurationValue[];
+export interface DdbSymbolExtendedValue {
+    base_id: number;
+    base: string[];
+    data: Uint32Array;
+}
+export declare const dictables: Set<DdbType>;
+/** 工具，取得某个 DdbType 的字节数 */
+export declare const ddb_tensor_bytes: Record<DdbType.bool | DdbType.char | DdbType.short | DdbType.int | DdbType.long | DdbType.float | DdbType.double, number>;
+export type TensorElem = TensorData | boolean | number | bigint | null | string;
+export interface TensorData extends Array<TensorElem> {
+}
+export interface DdbTensorMetadata {
+    /** Tensor 的元素的数据类型 */
+    data_type: DdbType;
+    /** Tensor 类型 */
+    tensor_type: number;
+    /** 设备类型 */
+    device_type: number;
+    /** Tensor Flags */
+    tensor_flags: number;
+    /** 维度 */
+    dimensions: number;
+    /** shape, shape[i] 表示第 i 个维度的 size */
+    shape: number[];
+    /** strides, strides[i] 表示在第 i 个维度，一个元素与下一个元素的距离 */
+    strides: number[];
+    /** 保留值 */
+    preserve_value: bigint;
+    /** 元素个数 */
+    elem_count: number;
+}
+export interface DdbTensorValue extends DdbTensorMetadata {
+    /** 数据 */
+    data: Uint8Array;
+}
+/** DdbObj.data() 返回的表格对象 */
+export interface DdbTableData<TRow = any> {
+    /** 表名 */
+    name: string;
+    /** 每一列的名称 */
+    columns: string[];
+    /** 每一列的原始 ddb 数据类型 */
+    types: DdbType[];
+    /** 表格数据，每一行的对象组成的数组 */
+    data: TRow[];
+}
+/** DdbObj.data() 返回的 Tensor 对象 */
+export interface DdbTensorData extends DdbTensorMetadata {
+    /** 数据 */
+    data: TensorData;
+}
+/** DdbObj.data() 返回的矩阵对象 */
+export interface DdbMatrixData {
+    /** 原始数据类型 */
+    type: DdbType;
+    /** 行数 */
+    nrows: number;
+    /** 列数 */
+    ncolumns: number;
+    /** 行名称 */
+    rows?: any[];
+    /** 列名称 */
+    columns?: any[];
+    /** 数据， data[0][1] 为第 0 行第 1 列数据 */
+    data: any[][];
+}
+export type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
+[
+    number,
+    number
+] | // complex, point
+DdbFunctionDefValue | DdbDurationValue | DdbDecimal32Value | DdbDecimal64Value | DdbDecimal128Value;
+export type IotVectorItemValue = [number | string | bigint | boolean][];
+/** 根据 DdbType 获取其名称，array vector type 自动在后面加上 [] */
+export declare function get_type_name(type: DdbType): string;
+export declare function is_decimal_type(type: DdbType): type is DdbType.decimal32 | DdbType.decimal64 | DdbType.decimal128;
+export declare function is_decimal_null_value(type: DdbType, value: number | bigint): boolean;
+export declare function get_duration_unit(code: number): string;
+export declare function get_ddb_time_value(classname: 'DdbDateTime' | 'DdbTimeStamp' | 'DdbNanoTimeStamp' | 'DdbDate', value: null | number | string | Date | Dayjs): number | bigint | null;
+export declare function get_big_uint_128(dataview: DataView, byte_offset: number, le?: boolean): bigint;
+export declare function get_big_int_128(dataview: DataView, byte_offset: number, le?: boolean): bigint;
+export declare function set_big_uint_128(dataView: DataView, byte_offset: number, value: bigint, le?: boolean): void;
+export declare function set_big_int_128(dataview: DataView, byte_offset: number, value: bigint, le?: boolean): void;
+export declare function generate_array_type(baseType: string, dimensions: number[]): 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;
+/** _datetime_formatter.format 会在 date 为 Invalid Date 时抛出错误 */
+export declare function timestamp2ms(timestamp: bigint | number | 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 ConvertOptions {
+    /** `'string'` blob 转换格式 */
+    blob?: 'string' | 'binary';
+    /** `'string'` char 转换格式: string 转为 string[]，number 转为 number[] */
+    char?: 'string' | 'number';
+    /** `'strings'` char vector 转换格式: strings 转为 string[], binary 转为 Uint8Array */
+    chars?: 'strings' | 'binary';
+    /** `'ms'` timestamp 类型转换为字符串表示时显示到秒还是毫秒 */
+    timestamp?: 's' | 'ms';
+}
+export declare const winsize: 10000;
+export type DdbRpcType = 'script' | 'function' | 'variable' | 'connect';