Class Kalix

Kalix service.

param options: the options for starting the service

Hierarchy

Kalix

Index

Properties

discoveryCompleted

Constructors

constructor

Methods

Properties

discoveryCompleted

discoveryCompleted: boolean = false

Constructors

constructor

new Kalix(options?: KalixOptions): Kalix

- Defined in src/kalix.ts:438
Parameters
- Optional options: KalixOptions
Returns Kalix

Methods

setProxyPort

setProxyPort(port: number): void

- Defined in src/kalix.ts:469
Set the port that the proxy is running on, for calls from the SDK to the proxy. Used by the testkit.

Parameters
- port: number
Returns void

addComponent

addComponent(...components: Component[]): Kalix

- Defined in src/kalix.ts:479
Add one or more components to this Kalix service.

Parameters
- Rest ...components: Component[]
  
  the components to add
Returns Kalix
this Kalix service

getComponents

getComponents(): Component[]

- Defined in src/kalix.ts:484
Returns Component[]

start

start(binding?: ServiceBinding): Promise<number>

- Defined in src/kalix.ts:511
Start the Kalix service.

Parameters
- Optional binding: ServiceBinding
  
  optional address/port binding to start the service on
Returns Promise<number>
a Promise of the bound port for this service

shutdown

shutdown(): void

- Defined in src/kalix.ts:618
Shut down the Kalix service.

Returns void

tryShutdown

tryShutdown(callback: ((error?: Error) => void)): void

- Defined in src/kalix.ts:629
Shut down the Kalix service.

Parameters
- callback: ((error?: Error) => void)
  
  shutdown callback, accepting possible error
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

Generated using TypeDoc