Home

Awesome

gRPC Reflection JS

npm version CI codecov

A JS library for talking with any gRPC Server that implements Reflection protocol.

Installation

Install with npm:

npm install grpc-reflection-js @grpc/grpc-js

Install with yarn:

yarn add grpc-reflection-js @grpc/grpc-js

Usage

Initialize

const grpc = require('grpc');
const grpcReflection = require('grpc-reflection-js');

const grpcReflectionServer = '<gRPC Reflection server host>'
const reflectionClient = new grpcReflection.Client(
  grpcReflectionServer,
  grpc.credentials.createInsecure()
);

listServices

const services = await reflectionClient.listServices()

Output

['grpc.reflection.v1alpha.ServerReflection', 'phone.Messenger']

fileContainingSymbol

const root = await reflectionClient.fileContainingSymbol('phone.Messenger')

fileByFilename

const root = await reflectionClient.fileContainingSymbol('contact.proto')

License

GitHub license

MIT