@rocketmq/protobuf 0.1.0 → 0.1.1
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 +26 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @rocketmq/protobuf
|
|
2
|
+
|
|
3
|
+
Protobuf generation utilities for RocketMQ.
|
|
4
|
+
|
|
5
|
+
This package translates TypeScript schema metadata (gathered via `@rocketmq/schema` decorators) into dynamic Protobuf v3 definitions. These definitions are passed as AMQP headers to the broker, enabling native, broker-side schema validation without requiring a separate schema registry service.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @rocketmq/protobuf
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
This is an internal package used by `@rocketmq/core`.
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { toProto } from '@rocketmq/protobuf';
|
|
19
|
+
|
|
20
|
+
// Translates a decorated class into a proto3 definition string
|
|
21
|
+
const protoDefinition = toProto(MyDecoratedClass);
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## License
|
|
25
|
+
|
|
26
|
+
Apache 2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rocketmq/protobuf",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
}
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@rocketmq/schema": "0.1.
|
|
12
|
+
"@rocketmq/schema": "0.1.1"
|
|
13
13
|
},
|
|
14
14
|
"scripts": {
|
|
15
15
|
"build": "tsup",
|