dolphindb 2.0.958 → 2.0.960

package/.eslintrc.json

@@ -9,6 +9,7 @@
     "parserOptions": {
         "ecmaVersion": "latest",
         "sourceType": "module",
+        "project": "./tsconfig.json",
         "ecmaFeatures": {
             "jsx": true
         }
@@ -30,7 +31,6 @@
     },
     
     "rules": {
-        "semi": "off",
         "@typescript-eslint/semi": ["error", "never"],
         "@typescript-eslint/no-extra-semi": "error",
         "semi-style": ["error", "first"],
@@ -38,8 +38,21 @@
         // 使用 ===
         "eqeqeq": "error",
         
+        // 父类尽量返回 this 类型
+        "@typescript-eslint/prefer-return-this-type": "error",
+        
+        // 尽量使用 . 访问属性而不是 []
+        "@typescript-eslint/dot-notation": "error",
+        
+        // 必须 throw Error
+        "@typescript-eslint/no-throw-literal": "error",
+        
+        // ------------ async
+        // 返回 Promise 的函数一定要标记为 async 函数
+        "@typescript-eslint/promise-function-async": "error",
+        
         // 不要 return await promise, 直接 return promise, 除非外面有 try catch
-        "no-return-await": "error",
+        "@typescript-eslint/return-await": "error",
         
         // ------------ 括号
         
@@ -57,7 +70,13 @@
         // ------------ 空格
         
         // { a, b } 这样的对象，大括号里面要有空格
-        "object-curly-spacing": ["error", "always"],
+        "@typescript-eslint/object-curly-spacing": ["error", "always"],
+        
+        // [a, b, c]
+        "@typescript-eslint/comma-spacing": "error",
+        
+        // foo()
+        "@typescript-eslint/func-call-spacing": "error",
         
         // a => { } 中箭头左右两边空格
         "arrow-spacing": ["error"],
@@ -72,17 +91,32 @@
         "block-spacing": ["error", "always"],
         
         // aaa: 123
-        "key-spacing": ["error", { "beforeColon": false, "afterColon": true, "mode": "minimum" }],
+        "@typescript-eslint/key-spacing": ["error", { "beforeColon": false, "afterColon": true, "mode": "minimum" }],
+        
+        // aaa: string
+        "@typescript-eslint/type-annotation-spacing": ["error"],
         
         // if ()
-        "keyword-spacing": ["error", { "before": true, "after": true }],
+        "@typescript-eslint/keyword-spacing": ["error", { "before": true, "after": true }],
+        
+        // if (1) { }
+        "@typescript-eslint/space-before-blocks": "error",
+        
+        // case 1: ...
+        "switch-colon-spacing": "error",
         
         // a + b
-        "space-infix-ops": ["error"],
+        "@typescript-eslint/space-infix-ops": "error",
+        
+        // 不允许使用 tab
+        "no-tabs": "error",
         
         // 使用 \n 换行
         "linebreak-style": ["error", "unix"],
         
+        // 文件以 \n 结尾
+        "eol-last": ["error", "always"],
+        
         // ------------ 引号
         
         // 用单引号
@@ -92,6 +126,23 @@
         "quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": false }],
         
         // 不要冗余的引号包裹属性
-        "quote-props": ["error", "as-needed", { "keywords": false, "unnecessary": true }]
+        "quote-props": ["error", "as-needed", { "keywords": false, "unnecessary": true }],
+        
+        // ------------ 其它
+        // 单行类型声明用 `,` 分割，多行类型声明结尾不要加分号
+        "@typescript-eslint/member-delimiter-style": ["error", {
+            "multiline": {
+                "delimiter": "none",
+                "requireLast": false
+            },
+            "singleline": {
+                "delimiter": "comma",
+                "requireLast": false
+            }
+        }],
+        
+        "@typescript-eslint/prefer-includes": "error",
+        
+        "@typescript-eslint/prefer-regexp-exec": "error"
     }
 }

package/README.md

@@ -46,7 +46,7 @@ npm install dolphindb
 ```ts
 import { DDB } from 'dolphindb'
 // The import method for existing projects using CommonJS modules is const { DDB } = require('dolphindb')
-// Use in browser: import { DDB } form 'dolphindb/browser.js'
+// Use in browser: import { DDB } from 'dolphindb/browser.js'
 
 // Initially connect to an instance of DolphinDB using the WebSocket URL (without establishing an actual network connection)
 let ddb = new DDB('ws://127.0.0.1:8848')
@@ -451,3 +451,41 @@ export interface StreamingData extends StreamingParams {
     error?: Error
 }
 ```
+
+
+### Development
+```shell
+# Install the latest version of nodejs
+# https://nodejs.org/en/download/current/
+
+# Install the pnpm package manager
+corepack enable
+corepack prepare pnpm@latest --activate
+
+git clone https://github.com/dolphindb/api-javascript.git
+
+cd api-javascript
+
+# Install project dependencies
+pnpm install
+
+# Copy .vscode/settings.template.json to .vscode/settings.json
+cp .vscode/settings.template.json .vscode/settings.json
+
+# Refer to scripts in package.json
+
+# Construct
+pnpm run build
+
+#lint
+pnpm run lint
+
+# test
+pnpm run test
+
+# scan entries
+pnpm run scan
+# Manually complete untranslated entries
+# Run the scan again to update the dictionary file dict.json
+pnpm run scan
+```

package/README.zh.md

@@ -46,7 +46,7 @@ npm install dolphindb
 ```ts
 import { DDB } from 'dolphindb'
 // 已有的使用 CommonJS 模块的项目的导入方法为 const { DDB } = require('dolphindb')
-// 在浏览器中使用: import { DDB } form 'dolphindb/browser.js'
+// 在浏览器中使用: import { DDB } from 'dolphindb/browser.js'
 
 // 使用 WebSocket URL 初始化连接到 DolphinDB 的实例（不建立实际的网络连接）
 let ddb = new DDB('ws://127.0.0.1:8848')
@@ -448,3 +448,41 @@ export interface StreamingData extends StreamingParams {
     error?: Error
 }
 ```
+
+
+### 开发
+```shell
+# 安装最新版的 nodejs
+# https://nodejs.org/en/download/current/
+
+# 安装 pnpm 包管理器
+corepack enable
+corepack prepare pnpm@latest --activate
+
+git clone https://github.com/dolphindb/api-javascript.git
+
+cd api-javascript
+
+# 安装项目依赖
+pnpm install
+
+# 将 .vscode/settings.template.json 复制为 .vscode/settings.json
+cp .vscode/settings.template.json .vscode/settings.json
+
+# 参考 package.json 中的 scripts
+
+# 构建
+pnpm run build
+
+# lint
+pnpm run lint
+
+# 测试
+pnpm run test
+
+# 扫描词条
+pnpm run scan
+# 手动补全未翻译词条
+# 再次运行扫描以更新词典文件 dict.json
+pnpm run scan
+```

package/browser.d.ts

@@ -108,6 +108,7 @@ export interface DdbDecimal64Value {
     /** int64, 空值为 null  empty value is null */
     data: bigint | null;
 }
+export type DdbDurationVectorValue = DdbDurationValue[];
 export interface DdbDecimal32VectorValue {
     scale: number;
     data: Int32Array;
@@ -176,10 +177,10 @@ export type DdbScalarValue = null | boolean | number | bigint | string | Uint8Ar
     number
 ] | // complex, point
 DdbFunctionDefValue | DdbDurationValue | DdbDecimal32Value | DdbDecimal64Value;
-export type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
+export type DdbVectorValue = null | Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
 Uint8Array[] | // blob
 DdbObj[] | // any
-DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDecimal64VectorValue;
+DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDecimal64VectorValue | DdbDurationVectorValue;
 export type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
 export type DdbStringObj = DdbObj<string>;
 export type DdbVectorObj<TValue extends DdbVectorValue = DdbVectorValue> = DdbObj<TValue>;

package/browser.js

@@ -612,6 +612,8 @@ class DdbObj {
     /** 有可能没有字节对齐，不能直接使用原有 message 的 arraybuffer, 统一复制出来，让原有 arraybuffer 被回收掉比较好 */
     static parse_vector_items(buf, le, type, length) {
         switch (type) {
+            case DdbType.void:
+                return [0, null];
             case DdbType.bool:
             case DdbType.char:
                 return [
@@ -777,15 +779,31 @@ class DdbObj {
                     }
                 ];
             }
-            // case DdbType.duration: -> 实际会返回一个 any vector
+            // 以下情况时, DdbType.duration 实际会返回一个 any vector
             // [2y, 1M, 3d, 7H, 11m, 12s, 15ms, 16us, 17ns]
             // <Buffer 19 01 type = any, form = vector
             // 09 00 00 00 01 00 00 00 rows = 9, cols = 1
             // 24 00 type = DdbType.duration, form = scalar
             // 02 00 00 00 09 00 00 00 
             // 24 00 01 00 00 00 08 00 00 00 24 00 03 00 00 00 06 00 00 00 24 00 07 00 00 00 05 00 00 00 ... 50 more bytes>
+            // 其余情况 (目前仅 pair) 下, 会返回特殊的 duration 序列化
+            // 4 bytes data 4 bytes unit
+            // 01 00 00 00 data: 1 
+            // 01 00 00 00 unit: 1
+            // 02 00 00 00 data: 2
+            // 02 00 00 00 unit: 2
+            case DdbType.duration: {
+                const dv = new DataView(buf.buffer, buf.byteOffset);
+                let durations = [];
+                for (let i = 0; i < length; i++)
+                    durations.push({
+                        data: dv.getInt32(0 + 8 * i, le),
+                        unit: dv.getInt32(4 + 8 * i, le)
+                    });
+                return [8 * length, durations];
+            }
             default:
-                return [0, buf];
+                throw new Error(t('vector<{{type}}> 暂时不支持解析', { type: String(DdbType[type] || type) }));
         }
     }
     pack() {
@@ -972,6 +990,8 @@ class DdbObj {
     }
     static pack_vector_body(value, type, length) {
         switch (type) {
+            case DdbType.void:
+                return [];
             case DdbType.bool:
                 return [value];
             case DdbType.char:
@@ -1141,6 +1161,8 @@ class DdbObj {
                                 items[i] = base[data[i]].quote('single');
                             return format_array(items, data.length > limit);
                         }
+                        case DdbType.void:
+                            return format(this.type, this.value, this.le, options);
                         case DdbType.uuid:
                         case DdbType.int128:
                         case DdbType.ipaddr: {
@@ -1573,6 +1595,8 @@ export function formati(obj, index, options = {}) {
             const { base, data } = obj.value;
             return format(DdbType.string, base[data[index]], obj.le, options);
         }
+        case DdbType.void:
+            return format(obj.type, obj.value, obj.le, options);
         case DdbType.uuid:
         case DdbType.int128:
         case DdbType.ipaddr:
@@ -2268,7 +2292,7 @@ class DDB {
             this.streaming = options.streaming;
     }
     on_message(buffer, websocket) {
-        throw t('这是在调用 this.rpc 之前默认的 on_message, 不应该被调用到，除非建立连接后 server 先推送了 message');
+        throw new Error(t('这是在调用 this.rpc 之前默认的 on_message, 不应该被调用到，除非建立连接后 server 先推送了 message'));
     }
     on_error() {
         // 这里的实现一定会被 connect, rpc 中的实现覆盖