Namespace ReplicatedEntity

Index

Interfaces

Type Aliases

Type Aliases

CommandHandler

CommandHandler<State>: ((command: any, context: replicatedentity.ReplicatedEntity.CommandContext<State>) => Promise<CommandReply> | CommandReply)

Type Parameters

State extends ReplicatedData = ReplicatedData

the type of ReplicatedData state

Type declaration

- (command: any, context: replicatedentity.ReplicatedEntity.CommandContext<State>): Promise<CommandReply> | CommandReply
- A command handler callback.
  
  Parameters
  - command: any
    
    The command message, this will be of the type of the gRPC service call input type
  - context: replicatedentity.ReplicatedEntity.CommandContext<State>
    
    The command context
  Returns Promise<CommandReply> | CommandReply
  The message to reply with, which must match the gRPC service call output type for this command.

CommandHandlers

CommandHandlers<State>: {}

Replicated entity command handlers.

Type Parameters

State extends ReplicatedData = ReplicatedData

the type of ReplicatedData state

Type declaration

[commandName: string]: replicatedentity.ReplicatedEntity.CommandHandler<State>

OnStateSetCallback

OnStateSetCallback<State>: ((state: State, entityId: string) => void)

Type Parameters

State extends ReplicatedData = ReplicatedData

the type of ReplicatedData state

Type declaration

- (state: State, entityId: string): void
- A state set handler callback.
  
  remarks
  This is invoked whenever a new state is set on the Replicated Entity, to allow the state to be enriched with domain specific properties and methods. This may be due to the state being set explicitly from a command handler on the command context, or implicitly as the default value, or implicitly when a new state is received from the proxy.
  
  Parameters
  - state: State
    
    The Replicated Data state that was set
  - entityId: string
    
    The id of the entity
  Returns void

DefaultValueCallback

DefaultValueCallback<State>: ((entityId: string) => State | null)

Type Parameters

State extends ReplicatedData = ReplicatedData

the type of ReplicatedData state

Type declaration

- (entityId: string): State | null
- A callback that is invoked to create a default value if the Kalix proxy doesn't send an existing one.
  
  Parameters
  - entityId: string
    
    The id of the entity
  Returns State | null
  The default value to use for this entity

Generated using TypeDoc