Class ValueEntity<State, CommandHandlers>

Value Entity.

Type Parameters

State extends Serializable = any

the type of Serializable state
CommandHandlers extends ValueEntity.CommandHandlers<State> = ValueEntity.CommandHandlers<State>

optional type of CommandHandlers

Hierarchy

ValueEntity

Implements

Entity

Index

Properties

Constructors

constructor

Methods

Properties

Readonly serviceName

serviceName: string

The gRPC service name for this component.

Readonly service

service: Service

The protobuf Service for this component.

Readonly options

options: Required<ValueEntity.Options>

Options for this component.

Optional clients

clients?: GrpcClientLookup

Access to gRPC clients (with promisified unary methods).

Optional initial

initial?: ValueEntity.InitialCallback<State>

The initial state callback.

commandHandlers

commandHandlers: CommandHandlers

The command handlers.

Constructors

constructor

new ValueEntity<State, CommandHandlers>(desc: string | string[], serviceName: string, entityType: string, options?: ValueEntity.Options): ValueEntity<State, CommandHandlers>

- Defined in src/value-entity.ts:178
Create a new value entity.

remarks
Never change the entityType after deploying a service that stored data of this type.

Type Parameters
- State extends Serializable = any
- CommandHandlers extends ValueEntity.CommandHandlers<State> = ValueEntity.CommandHandlers<State>
Parameters
- desc: string | string[]
  
  A descriptor or list of descriptors to parse, containing the service to serve
- serviceName: string
  
  The fully qualified name of the service that provides this entities interface
- entityType: string
  
  The entity type name for all value entities of this type
- Optional options: ValueEntity.Options
  
  The options for this entity
Returns ValueEntity<State, CommandHandlers>

Methods

preStart

preStart(settings: PreStartSettings): void

Implementation of Entity.preStart
- Defined in src/value-entity.ts:213
Parameters
- settings: PreStartSettings
Returns void

lookupType

lookupType(messageType: string): Type

Implementation of Entity.lookupType
- Defined in src/value-entity.ts:228
Lookup a protobuf message type.

This is provided as a convenience to lookup protobuf message types.

Parameters
- messageType: string
Returns Type
The protobuf message type

setInitial

setInitial(callback: ValueEntity.InitialCallback<State>): ValueEntity<State, CommandHandlers>

- Defined in src/value-entity.ts:238
Set the initial state callback.

Parameters
- callback: ValueEntity.InitialCallback<State>
  
  The initial state callback
Returns ValueEntity<State, CommandHandlers>
This entity

setCommandHandlers

setCommandHandlers(commandHandlers: CommandHandlers): ValueEntity<State, CommandHandlers>

- Defined in src/value-entity.ts:251
Set the command handlers of the entity.

Parameters
- commandHandlers: CommandHandlers
  
  The command handler callbacks
Returns ValueEntity<State, CommandHandlers>
This entity

Generated using TypeDoc