https://github.com/k8w/tsrpc-proto

TSRPC service proto definition
https://github.com/k8w/tsrpc-proto

Last synced: 5 months ago
JSON representation

TSRPC service proto definition

• Host: GitHub
• URL: https://github.com/k8w/tsrpc-proto
• Owner: k8w
• License: mit
• Created: 2019-07-22T06:40:15.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-06T06:45:28.000Z (about 3 years ago)
• Last Synced: 2025-04-18T00:06:58.746Z (6 months ago)
• Language: TypeScript
• Size: 254 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TSRPC Proto

## Introduction

- [TSRPC](https://github.com/k8w/tsrpc) is a TypeScript RPC framework, with runtime type check and binary serialization, both support HTTP and WebSocket.

- `TSRPCProto` is the service definition of it.

- It includes two type service: `ApiService` and `MsgService`.

    - ApiService is like B/S model, send request and wait for reponse.

    - MsgService is like pub/sub model, send and listen specific message.

- Also include some type definition that shared between TSRPC families.

## API

See [API Reference](./docs/api/tsrpc-proto.md).