Class AggregateRoot<EntityState>`Abstract`

Type Parameters

EntityState extends AggregateRootState

Hierarchy (View Summary)

Entity<EntityState>
- AggregateRoot

Implements

IAggregateRoot<EntityState>

Index

Constructors

Methods

checkStateValidity getSnapshot updateAndCheckStateValidity

Constructors

constructor

new AggregateRoot<EntityState extends { id: string }>(
state: EntityState,
): AggregateRoot<EntityState>
Type Parameters
- EntityState extends { id: string }
Parameters
- state: EntityState
Returns AggregateRoot<EntityState>
Inherited from Entity.constructor
- Defined in packages/core/src/entities/entity.ts:5

Methods

`Protected` `Abstract`checkStateValidity

checkStateValidity(newState: EntityState): IResult
Parameters
- newState: EntityState
Returns IResult
Inherited from Entity.checkStateValidity
- Defined in packages/core/src/entities/entity.ts:25

getSnapshot

getSnapshot(): EntityState
Returns EntityState
Implementation of IAggregateRoot.getSnapshot

Inherited from Entity.getSnapshot
- Defined in packages/core/src/entities/entity.ts:21

updateAndCheckStateValidity

updateAndCheckStateValidity(
settingFunction: (oldState: EntityState) => Partial<EntityState>,
): void
Parameters
- settingFunction: (oldState: EntityState) => Partial<EntityState>
Returns void
Implementation of IAggregateRoot.updateAndCheckStateValidity

Inherited from Entity.updateAndCheckStateValidity
- Defined in packages/core/src/entities/entity.ts:9