Interface IEntity<EntityState>

interface IEntity<EntityState> {
    checkStateValidity(newState): IResult<void>;
    getSnapshot(): EntityState;
    updateAndCheckStateValidity(settingFunction): void;
}

Type Parameters

EntityState

Hierarchy (view full)

ISnapshotable<EntityState>
- IEntity

Implemented by

Entity

Index

Methods

checkStateValidity getSnapshot updateAndCheckStateValidity

Methods

checkStateValidity

checkStateValidity(newState): IResult<void>
Parameters
- newState: EntityState
Returns IResult<void>
- Defined in src/primitives/oop/entity/entity.interface.ts:8

getSnapshot

getSnapshot(): EntityState
Returns EntityState
Inherited from ISnapshotable.getSnapshot
- Defined in src/primitives/oop/snapshotable.interface.ts:2

updateAndCheckStateValidity

updateAndCheckStateValidity(settingFunction): void
Parameters
- settingFunction: ((oldState) => Partial<EntityState>)
  - - (oldState): Partial<EntityState>
    - Parameters
      oldState: EntityState
      Returns Partial<EntityState>
Returns void
- Defined in src/primitives/oop/entity/entity.interface.ts:5