@mingzey/typedrpc 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -7
- package/README.zh-CN.md +10 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9,17 +9,20 @@ TypeScript-based RPC framework with support for multiple connection types includ
|
|
|
9
9
|
|
|
10
10
|
## Features
|
|
11
11
|
|
|
12
|
-
- **Type-Safe RPC calls** - Leverage TypeScript's type system for end-to-end type safety
|
|
13
|
-
- **Multiple connection types** - Support for HTTP, Socket, and SocketIO connections, or custom connection providers
|
|
14
|
-
- **Middleware support** - Extensible middleware system for request/response handling
|
|
15
|
-
- **Context-aware** - Built-in context system for passing data between handlers
|
|
16
|
-
- **Bidirectional communication** - Support for two-way RPC calls between client and server, capability depends on connection type
|
|
17
|
-
- **Easy to use** - Simple API for defining services and methods
|
|
12
|
+
- 🛡️ **Type-Safe RPC calls** - Leverage TypeScript's type system for end-to-end type safety
|
|
13
|
+
- 🔌 **Multiple connection types** - Support for HTTP, Socket, and SocketIO connections, or custom connection providers
|
|
14
|
+
- 🔄 **Middleware support** - Extensible middleware system for request/response handling
|
|
15
|
+
- 📝 **Context-aware** - Built-in context system for passing data between handlers
|
|
16
|
+
- 🔁 **Bidirectional communication** - Support for two-way RPC calls between client and server, capability depends on connection type
|
|
17
|
+
- 📦 **Easy to use** - Simple API for defining services and methods
|
|
18
|
+
- 🚀 **Zero dependencies** - No external library dependencies, only depends on TypeScript standard library
|
|
19
|
+
- 🌐 **Frontend and backend compatible** - Can be used in Node.js backend and browser frontend
|
|
20
|
+
- 📈 **High extensibility** - Can be easily integrated into frameworks like Electron, Express as an RPC solution
|
|
18
21
|
|
|
19
22
|
## Installation
|
|
20
23
|
|
|
21
24
|
```bash
|
|
22
|
-
npm install typedrpc
|
|
25
|
+
npm install @mingzey/typedrpc
|
|
23
26
|
```
|
|
24
27
|
|
|
25
28
|
## Basic Usage
|
package/README.zh-CN.md
CHANGED
|
@@ -10,17 +10,20 @@
|
|
|
10
10
|
|
|
11
11
|
## 特性
|
|
12
12
|
|
|
13
|
-
- **类型安全的 RPC 调用** - 利用 TypeScript 的类型系统实现端到端的类型安全
|
|
14
|
-
- **多种连接类型** - 支持 HTTP、Socket 和 SocketIO 连接,或自定义`TypedRPCConnectionProvider`
|
|
15
|
-
- **中间件支持** - 可扩展的中间件系统,用于请求/响应处理
|
|
16
|
-
- **上下文感知** - 内置上下文系统,用于在处理程序之间传递数据
|
|
17
|
-
- **双向通信** - 支持客户端和服务器之间的双向 RPC 调用,能力取决于连接类型
|
|
18
|
-
- **易于使用** - 用于定义服务和方法的简单 API
|
|
13
|
+
- 🛡️ **类型安全的 RPC 调用** - 利用 TypeScript 的类型系统实现端到端的类型安全
|
|
14
|
+
- 🔌 **多种连接类型** - 支持 HTTP、Socket 和 SocketIO 连接,或自定义`TypedRPCConnectionProvider`
|
|
15
|
+
- 🔄 **中间件支持** - 可扩展的中间件系统,用于请求/响应处理
|
|
16
|
+
- 📝 **上下文感知** - 内置上下文系统,用于在处理程序之间传递数据
|
|
17
|
+
- 🔁 **双向通信** - 支持客户端和服务器之间的双向 RPC 调用,能力取决于连接类型
|
|
18
|
+
- 📦 **易于使用** - 用于定义服务和方法的简单 API
|
|
19
|
+
- 🚀 **零依赖** - 不依赖任何外部库,仅依赖 TypeScript 标准库
|
|
20
|
+
- 🌐 **前后端通用** - 可在 Node.js 后端和浏览器前端使用
|
|
21
|
+
- 📈 **高拓展性** - 可轻松集成入 Electron、Express 等框架作为 RPC 调用方案
|
|
19
22
|
|
|
20
23
|
## 安装
|
|
21
24
|
|
|
22
25
|
```bash
|
|
23
|
-
npm install typedrpc
|
|
26
|
+
npm install @mingzey/typedrpc
|
|
24
27
|
```
|
|
25
28
|
|
|
26
29
|
## 基本使用
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mingzey/typedrpc",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"description": "TypeScript-based RPC framework with support for multiple connection types including HTTP, Socket, and SocketIO or custom",
|
|
5
5
|
"author": "MingZeY <1552904342@qq.com>",
|
|
6
6
|
"repository": {
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"scripts": {
|
|
22
22
|
"test": "tsx test/test.ts",
|
|
23
23
|
"build": "tsc -p tsconfig.build.json",
|
|
24
|
-
"check": "tsc
|
|
24
|
+
"check": "tsc --noEmit"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"@types/express": "^5.0.6",
|