Skip to main content

GrpcServiceParameters

@webda/grpc

Class: GrpcServiceParameters

Defined in: grpc/src/grpcservice.service.ts:27

Parameters for the gRPC service

Extends​

  • OperationsTransportParameters

Constructors​

Constructor​

new GrpcServiceParameters(): GrpcServiceParameters

Returns​

GrpcServiceParameters

Inherited from​

OperationsTransportParameters.constructor

Properties​

operations?​

optional operations?: string[]

Defined in: core/lib/services/operationstransport.d.ts:13

List of operations to include/exclude Supports wildcards and negation: ["*", "!User.Delete"]

Default​

["*"]

Inherited from​

OperationsTransportParameters.operations

packageName?​

optional packageName?: string

Defined in: grpc/src/grpcservice.service.ts:38

Protobuf package name

Default​

"webda"

protoFile?​

optional protoFile?: string

Defined in: grpc/src/grpcservice.service.ts:32

Path to the generated .proto file

Default​

".webda/app.proto"

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

OperationsTransportParameters.type

Methods​

isIncluded()​

isIncluded(operationId): boolean

Defined in: core/lib/services/operationstransport.d.ts:37

Check if an operation is included by this transport

Parameters​

operationId​

string

the operation identifier

Returns​

boolean

true if the operation is included

Inherited from​

OperationsTransportParameters.isIncluded

load()​

load(params?): this

Defined in: grpc/src/grpcservice.service.ts:45

Load and apply default parameter values.

Parameters​

params?​

any = {}

raw configuration object to load into this parameters instance

Returns​

this

this instance with defaults applied

Overrides​

OperationsTransportParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

OperationsTransportParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

OperationsTransportParameters.with