TSRPC 项目教程

TSRPC 项目教程

tsrpcA TypeScript RPC framework, with runtime type checking and serialization, support both HTTP and WebSocket. It is very suitable for website / APP / games, and absolutely comfortable to full-stack TypeScript developers.项目地址:https://gitcode.com/gh_mirrors/ts/tsrpc

1. 项目的目录结构及介绍

TSRPC 项目的目录结构如下：

tsrpc/
├── benchmark/
├── res/
├── scripts/
├── src/
├── test/
├── .gitignore
├── .mocharc.js
├── CHANGELOG.md
├── LICENSE
├── README.md
├── api-extractor.json
├── package-lock.json
├── package.json
├── rollup.config.js
├── test.ts
├── tsconfig.json

目录介绍：

• benchmark/: 包含性能测试相关文件。
• res/: 资源文件夹，可能包含项目所需的各种资源文件。
• scripts/: 包含项目脚本文件，用于自动化任务。
• src/: 源代码文件夹，包含项目的核心代码。
• test/: 测试文件夹，包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .mocharc.js: Mocha 测试框架的配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• api-extractor.json: API 提取器配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: 项目依赖和脚本配置文件。
• rollup.config.js: Rollup 打包配置文件。
• test.ts: 测试入口文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/ 目录下，具体文件名可能因项目结构而异。以下是一个典型的启动文件示例：

// src/index.ts
import { createServer } from 'tsrpc';
import { serviceProto } from './shared/protocols/serviceProto';

// 创建服务器
const server = createServer(serviceProto, {
    // 配置选项
});

// 启动服务器
server.start();

启动文件介绍：

• createServer: 创建 TSRPC 服务器的函数。
• serviceProto: 服务协议定义，通常位于 shared/protocols/ 目录下。
• server.start(): 启动服务器的方法。

3. 项目的配置文件介绍

tsconfig.json

TypeScript 配置文件，用于配置 TypeScript 编译选项：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*"]
}

package.json

项目依赖和脚本配置文件：

{
  "name": "tsrpc",
  "version": "1.0.0",
  "description": "A TypeScript RPC framework with runtime type checking and serialization support both HTTP and WebSocket",
  "main": "dist/index.js",
  "scripts": {
    "start": "node dist/index.js",
    "build": "tsc",
    "test": "mocha"
  },
  "dependencies": {
    "tsrpc": "^3.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0",
    "mocha": "^8.0.0"
  }
}

.mocharc.js

Mocha 测试框架的配置文件：

module.exports = {
  require: 'ts-node/register',
  spec: 'test/**/*.test.ts'
};

以上是 TSRPC 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

tsrpcA TypeScript RPC framework, with runtime type checking and serialization, support both HTTP and WebSocket. It is very suitable for website / APP / games, and absolutely comfortable to full-stack TypeScript developers.项目地址:https://gitcode.com/gh_mirrors/ts/tsrpc