API 参考 / @142vip/grpc / GrpcProtoLoader

Class: GrpcProtoLoader

Defined in: core/grpc-proto-loader.ts:22

proto文件加载器

Constructors

Constructor

new GrpcProtoLoader(protoPath, loaderOptions?): GrpcProtoLoader

Defined in: core/grpc-proto-loader.ts:32

Parameters

protoPath

string | string[]

loaderOptions?

VipProtoLoaderOptions

Returns

GrpcProtoLoader

Methods

getClientServiceConstructor()

getClientServiceConstructor(servicePath): ServiceClientConstructor

Defined in: core/grpc-proto-loader.ts:112

获取client Service类定义，用于客户端

Parameters

servicePath

string

Returns

ServiceClientConstructor

---

getGrpcServiceDetail()

getGrpcServiceDetail(): GrpcServiceDetail[]

Defined in: core/grpc-proto-loader.ts:77

获取grpc service详细信息

Returns

GrpcServiceDetail[]

---

getLoaderOptions()

getLoaderOptions(): VipProtoLoaderOptions

Defined in: core/grpc-proto-loader.ts:54

获取proto loader options

Returns

VipProtoLoaderOptions

---

getPackageNames()

getPackageNames(): string[]

Defined in: core/grpc-proto-loader.ts:40

Returns

string[]

---

getServerServiceDefinition()

getServerServiceDefinition(servicePath): ServiceDefinition

Defined in: core/grpc-proto-loader.ts:100

获取rpc Service类定义

Parameters

servicePath

string

Returns

ServiceDefinition

---

getServiceDetail()

getServiceDetail(): GrpcServicePath[]

Defined in: core/grpc-proto-loader.ts:65

Returns

GrpcServicePath[]

---

getServiceName()

getServiceName(servicePath): string

Defined in: core/grpc-proto-loader.ts:47

获取grpc对应的service名称

Parameters

servicePath

string

Returns

string

---

getServicePaths()

getServicePaths(): string[]

Defined in: core/grpc-proto-loader.ts:61

获取所有的路径定义

Returns

string[]

---

isProtobufTypeDefinition()

isProtobufTypeDefinition(obj): obj is ProtobufTypeDefinition

Defined in: core/grpc-proto-loader.ts:123

判断是否是ProtobufTypeDefinition

Parameters

obj

ServiceClientConstructor | GrpcObject | ProtobufTypeDefinition

Returns

obj is ProtobufTypeDefinition