grpc / grpc/grpc-node

Not declaring generated ProtoGrpcType inheritance

Open
#2,851 1 comment 0 reactions 0 assignees View on GitHub
package: @grpc/proto-loader
Dominant language
TypeScript
Stars
4.8k
Forks
716
Avg merge
2d 3h
Merged PRs (30d)
10

Description

### Problem description
When using proto-loader-gen-types for ts-types generating, the root `ProtoGrpcType` type is not declared to `extends grpc.GrpcObject`.
Because of that, when I `grpc.loadPackageDefinition(...)`, I cannot cast it directly to `as MyProtoGrpcType` and I have to cast it to `as unknown` first.
Though root `ProtoGrpcType` is in fact the extension of `grpc.GrpcObject` -- the only problem is the absence of declaration.

### Reproduction steps
```typescript
import * as grpc from '@grpc/grpc-js';
import * as protoLoader from '@grpc/proto-loader';
import type { ProtoGrpcType as MyProtoGrpcType } from 'proto/my';

const myPackageDefinition = protoLoader.loadSync('my.proto', { includeDirs: [ 'proto' ] });
const myProtoDescriptor = grpc.loadPackageDefinition(myPackageDefinition) as unknown as MyGrpcType;
```

### Environment
- Any OS name, version and architecture
- Any Node version
- Any Node installation method (nvm or others)
- @grpc/proto-loader:0.7.13

### Additional context
@murgatroid99 , I strongly appreciate your creature: the proto-loader-gen-types!
It is a very helpful thing! And I even can go on with `as unknown` cast.
But this duct-tape of `as unknown` can be removed -- and please let's do it.
I created a PR addressing this problem, it's very simple. Please take a look.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.