add script/types

.github/workflows/publish-script-types.yml

@@ -0,0 +1,20 @@
+
+name: Publish Script type definition package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          package: script/types

script/README.MD

@@ -4,4 +4,25 @@
 
 # Script
 
+# TS support
+
+1. Install the package below:
+   ```sh
+   npm install --save-dev go-liter-plugin
+   ```
+
+2. Add the following element to your `tsconfig.json`
+   ```js
+   {
+   "compilerOptions": {
+   		"typeRoots": [
+   			"node_modules/@types",
+   			"node_modules/go-liter-plugin"
+   		]
+   	}
+   }
+   ```
+
+# Events
+
 TODO

script/README_zh.MD

@@ -32,13 +32,12 @@
 
 `EventEmitter` 的监听器有且仅传入一个参数 `event`, `Event` 对象的定义如下:
 ```ts
-class Event {
+interface Event {
 	name: string
 	data: Object
-	get cancelable(): bool
-	get canceled(): bool
-	cancel()
-	// 也会将 data 对象的键值对展开到 Event 对象中
+	readonly cancelable: boolean
+	readonly canceled: boolean
+	cancel(): void
 }
 ```
 
@@ -53,6 +52,7 @@ class Event {
 | `$`     | `serve`     | 服务端连接建立 | 阻止底层转发, 允许解析数据包并将触发 `packet` 事件 |
 | `Conn`  | `packet`    | 连接收到数据包 | 阻止该数据包的转发 |
 | `Conn`  | `error`     | 连接产生错误   | 不可撤销         |
-| `Conn`  | `close`     | 连接断开      | 对等连接将不会自动断开 |
+| `Conn`  | `close`     | 连接断开      | 不可撤销          |
+| `Conn`  | `before_close` | 由于对等方连接断开导致该连接准备断开 | 该连接将不会断开 |
 
 如果您想处理连接, 则必须在 `handshake` 或 `serve` 上调用 `cancel()` 方法, 否则 `packet` 事件不会触发

script/types/.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*