Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webrpc/gen-typescript
webrpc TypeScript client/server generator
https://github.com/webrpc/gen-typescript
client generator server typescript webrpc
Last synced: 4 days ago
JSON representation
webrpc TypeScript client/server generator
- Host: GitHub
- URL: https://github.com/webrpc/gen-typescript
- Owner: webrpc
- License: mit
- Created: 2022-10-06T02:12:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T14:02:11.000Z (26 days ago)
- Last Synced: 2024-12-10T14:43:58.842Z (26 days ago)
- Topics: client, generator, server, typescript, webrpc
- Language: TypeScript
- Homepage: https://github.com/webrpc/webrpc
- Size: 366 KB
- Stars: 9
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
webrpc-gen Typescript templates
===============================
This repo contains the templates used by the `webrpc-gen` cli to code-generate
webrpc Typescript server and client code.
This generator, from a webrpc schema/design file will code-generate:
1. Client -- an isomorphic/universal Typescript client to speak to a webrpc server using the
provided schema. This client is compatible with any webrpc server language (ie. Go, nodejs, etc.).
As the client is isomorphic, means you can use this within a Web browser or use the client in a
server like nodejs -- both without needing any dependencies. I suggest to read the generated TS
output of the generated code, and you shall see, its nothing fancy, just the sort of thing you'd
write by hand.
2. Server -- a nodejs Typescript server handler. See examples.
## Usage
```
webrpc-gen -schema=example.ridl -target=typescript -server -client -out=./example.gen.ts
```
or
```
webrpc-gen -schema=example.ridl -target=github.com/webrpc/[email protected] -server -client -out=./example.gen.ts
```
or
```
webrpc-gen -schema=example.ridl -target=./local-templates-on-disk -server -client -out=./example.gen.ts
```
As you can see, the `-target` supports default `typescript`, any git URI, or a local folder :)
### Set custom template variables
Change any of the following values by passing `-option="Value"` CLI flag to `webrpc-gen`.
| webrpc-gen -option | Description | Default value | Version |
|--------------------|----------------------|---------------------------------------------------|---------|
| `-client` | generate client code | unset (`false`) | v0.0.1 |
| `-server` | generate server code | unset (`false`) | v0.0.1 |
| `-webrpcHeader` | `true` | enable client send webrpc version in http headers | v0.15.0 |
## LICENSE
[MIT LICENSE](./LICENSE)