From 5fc75aa7b2e224b5c1e24ac5e06d21cbc209f1be Mon Sep 17 00:00:00 2001 From: Lewis Nelson Date: Thu, 26 Jan 2023 23:48:46 +0000 Subject: [PATCH] docs: updated example docs --- examples/README.md | 6 ++++++ examples/generated_client/README.md | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/examples/README.md b/examples/README.md index 34c87b6..fe6aa3c 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,9 @@ # Examples +The code inside `generated/` was created with the following command: + +```bash +npx grpc-ts generate ./example.proto ./generated +``` + - [Using the generated client](./generated_client/README.md) diff --git a/examples/generated_client/README.md b/examples/generated_client/README.md index 50c4043..0fd7438 100644 --- a/examples/generated_client/README.md +++ b/examples/generated_client/README.md @@ -3,3 +3,8 @@ The `grpc-ts` CLI tool will generate the output from [grpc-tools](https://www.npmjs.com/package/grpc-tools) as well as creating a client class which uses the [GenericClient](../generic_client/README.md) under the hood to make requests. The client class method names are a 1:1 mapping of the methods defined in the generated client class on the `_grpc_pb.d.ts` files. + +- [Bidirectional streaming](./bidirectionalStreaming.ts) +- [Client streaming](./clientStreaming.ts) +- [Server streaming](./serverStreaming.ts) +- [Unary requests](./unaryRequests.ts)