Skip to content

Commit

Permalink
Merge pull request #1 from lewnelson/beta
Browse files Browse the repository at this point in the history
Initial release
  • Loading branch information
lewnelson authored Jan 25, 2023
2 parents 206408d + 8deb5ad commit d7fd4b5
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- checkout
- node/install-packages
- run: npm run build
- run: npx semantic-release -d
- run: npx semantic-release

workflows:
version: 2
Expand Down
4 changes: 3 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.circleci/
.husky/
coverage/
scripts/
test/
Expand All @@ -7,7 +8,8 @@ test/
.gitignore
.nvmrc
.prettierrc
.releaserc
jest.config.js
jest.setup.js
jest.setup.ts
tsconfig.src.json
tsconfig.cli.json
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

This library is an abstraction on [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master) to provide a simpler interface for making requests from a gRPC client and generating fully typed gRPC clients from `.proto` files.

Go from this:

```typescript
client.getName(new GetNameRequest(), (error: Error | null, response: GetNameResponse | undefined) => {
// handle response in callback
});
```

to this:

```typescript
const response = await client.unaryRequest("getName", new GetNameRequest());
```

## Install

```bash
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
"promises",
"async"
],
"publishConfig": {
"access": "public"
},
"homepage": "https://github.com/lewnelson/grpc-ts#readme",
"bugs": {
"url": "https://github.com/lewnelson/grpc-ts/issues"
Expand Down

0 comments on commit d7fd4b5

Please sign in to comment.