KalixOptions | @kalix-io/kalix-javascript-sdk

Options for the Kalix user function.

Hierarchy

KalixOptions

Index

Properties

serviceName
serviceVersion
descriptorSetPath
delayDiscoveryUntilProxyPortSet
channelSettings

Properties

Optional serviceName

serviceName?: string

The name of this service.

defaultvalue: Defaults to name from package.json

Optional serviceVersion

serviceVersion?: string

The version of this service.

defaultvalue: Defaults to version from package.json

Optional descriptorSetPath

descriptorSetPath?: string

Path to a Protobuf FileDescriptor set, as output by protoc --descriptor_set_out=somefile.desc. This file must contain all of the component services that this Kalix service serves. See the compile-descriptor command for creating this file.

defaultvalue: "user-function.desc"

Optional delayDiscoveryUntilProxyPortSet

delayDiscoveryUntilProxyPortSet?: boolean

Delay completing discovery until proxyPort has been set by the testkit.

Optional channelSettings

channelSettings?: ChannelSettings

Channel settings.