Features
Docs
CLI
Benchmarks
Examples

© 2024 MoroJs

@morojs/moro


@morojs/moro / GrpcJsAdapter

Class: GrpcJsAdapter

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:30

@grpc/grpc-js adapter for MoroJS Provides full gRPC support for Node.js applications

Implements

Constructors

Constructor

new GrpcJsAdapter(): GrpcJsAdapter

Returns

GrpcJsAdapter

Methods

addService()

addService(serviceName, serviceDefinition, implementation): ServiceRegistration

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:185

Register a gRPC service with implementation

Parameters

serviceName

string

serviceDefinition

ServiceDefinition

implementation

ServiceImplementation

Returns

ServiceRegistration

Implementation of

GrpcAdapter.addService


createClient()

createClient(protoPath, serviceName, options): Promise<GrpcClient>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:378

Create a gRPC client for calling remote services

Parameters

protoPath

string

serviceName

string

options

GrpcClientOptions

Returns

Promise<GrpcClient>

Implementation of

GrpcAdapter.createClient


enableHealthCheck()

enableHealthCheck(): void

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:429

Enable health checking service

Returns

void

Implementation of

GrpcAdapter.enableHealthCheck


enableReflection()

enableReflection(): void

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:476

Enable server reflection

Returns

void

Implementation of

GrpcAdapter.enableReflection


getAdapterName()

getAdapterName(): string

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:487

Get adapter name

Returns

string

Implementation of

GrpcAdapter.getAdapterName


initialize()

initialize(options): Promise<void>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:46

Initialize the gRPC adapter

Parameters

options

GrpcOptions

Returns

Promise<void>

Implementation of

GrpcAdapter.initialize


isAvailable()

isAvailable(): Promise<boolean>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:491

Check if adapter is available

Returns

Promise<boolean>

Implementation of

GrpcAdapter.isAvailable


loadProto()

loadProto(protoPath, packageName?, options?): Promise<ServiceDefinition[]>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:105

Load a proto file and return service definitions

Parameters

protoPath

string

packageName?

string

options?

ProtoLoadOptions

Returns

Promise<ServiceDefinition[]>

Implementation of

GrpcAdapter.loadProto


start()

start(): Promise<GrpcServer>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:283

Start the gRPC server

Returns

Promise<GrpcServer>

Implementation of

GrpcAdapter.start


stop()

stop(): Promise<void>

Defined in: src/core/grpc/adapters/grpc-js-adapter.ts:358

Stop the gRPC server

Returns

Promise<void>

Implementation of

GrpcAdapter.stop