https://github.com/xanthous-tech/typescript-grpc
a minimalistic annotation-based typescript library to help build grpc servers and clients.
https://github.com/xanthous-tech/typescript-grpc
Last synced: about 1 year ago
JSON representation
a minimalistic annotation-based typescript library to help build grpc servers and clients.
- Host: GitHub
- URL: https://github.com/xanthous-tech/typescript-grpc
- Owner: xanthous-tech
- License: mit
- Created: 2020-03-19T14:51:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-02T21:36:46.000Z (about 4 years ago)
- Last Synced: 2025-03-31T11:02:39.347Z (about 1 year ago)
- Language: TypeScript
- Size: 524 KB
- Stars: 14
- Watchers: 4
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-grpc
a minimalistic annotation-based typescript library to help build grpc servers and clients.
# Usage
```
$ yarn add typescript-grpc protobufjs grpc @grpc/proto-loader --save
```
See [src/example.ts](src/example.ts)
```typescript
import debug from 'debug';
import { Type, Field, Message } from 'protobufjs';
import { load } from '@grpc/proto-loader';
import { Server, ServiceDefinition, ServerCredentials } from 'grpc';
import { Service, Method, generateProto, wrapServiceMethods } from 'typescript-grpc';
const log = debug('typescript-grpc:example');
@Type.d()
class Movie extends Message {
@Field.d(1, 'string')
name: string;
@Field.d(2, 'int32')
year: number;
@Field.d(3, 'float')
rating: number;
@Field.d(4, 'string', 'repeated')
cast: string[];
}
@Type.d()
class MoviesResult extends Message {
@Field.d(1, Movie, 'repeated')
result: Movie[];
}
@Type.d()
class EmptyRequest extends Message {}
@Type.d()
class SearchByCastInput extends Message {
@Field.d(1, 'string')
castName: string;
}
@Service()
class ExampleService {
@Method({
requestType: 'EmptyRequest',
requestStream: false,
responseType: 'MoviesResult',
responseStream: false,
})
async getMovies(req: EmptyRequest): Promise {
log('get movies called');
return new MoviesResult({ result: [] });
}
@Method({
requestType: 'SearchByCastInput',
requestStream: false,
responseType: 'Movie',
responseStream: true,
})
searchMoviesByCast(req: SearchByCastInput): Observable {
const movies = [
{
cast: ['Tom Cruise', 'Simon Pegg', 'Jeremy Renner'],
name: 'Mission: Impossible Rogue Nation',
rating: 0.97,
year: 2015,
},
{
cast: ['Tom Cruise', 'Simon Pegg', 'Henry Cavill'],
name: 'Mission: Impossible - Fallout',
rating: 0.93,
year: 2018,
},
{
cast: ['Leonardo DiCaprio', 'Jonah Hill', 'Margot Robbie'],
name: 'The Wolf of Wall Street',
rating: 0.78,
year: 2013,
},
];
return from(movies.filter(movie => movie.cast.indexOf(req.castName) > -1).map(m => new Movie(m)));
}
async function main(): Promise {
const service = new ExampleService();
log(service);
const protoPath = await generateProto('example');
const packageDefinition = await load(protoPath);
const server = new Server({
'grpc.max_send_message_length': -1,
'grpc.max_receive_message_length': -1,
});
server.addService(packageDefinition[service.constructor.name] as ServiceDefinition, wrapServiceMethods(service));
server.bind('0.0.0.0:50051', ServerCredentials.createInsecure());
server.start();
log(`server started`);
}
main();
```
# Features
- Modern service method handlers via Promise and rxjs streams
- Auto proto generation using annotations