Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@grpc.ts/cli

zgid12317MIT1.2.4TypeScript support: included

CLI package for @grpc.ts to generate typing for TypeScript

grpc, grpc-ts, grpc-js, grpc-typescript, grpc-javascript, grpc-cli

readme

A CLI to generate TypeScript typings from protobuf for gRPC.

This package is for supporting `@grpc.ts` packages.

Install

npm install --save-dev @grpc.ts/cli @grpc.ts/core

# or

yarn add -D @grpc.ts/cli @grpc.ts/core

# or

pnpm add -D @grpc.ts/cli @grpc.ts/core

Usage

  • Create config file grpc-cli.ts
import type { IConfigProps } from '@grpc.ts/cli';

const config: IConfigProps = {
  paths: ['../proto/*.proto'],
  external: ['google.protobuf'],
};

export default config;
  • Run script
pnpm gen-grpc-typing

Default output will be protobufTypings. Change output option to specify the folder you want to store the typing files.

TODO

[ x ] Support generate typing as monorepo project

[ ] Support rollup engine for monorepo config

[ ] Read prettier config from project