@eveble/eveble

Hierarchy

↳ Serializable

• Stateful

• Statusful

  ↳ Identifiable

• Serializable

• Stateful

• Statusful

• Identifiable

  ↳ Entity

  ↳ EventSourceable

Implemented by

• Aggregate
• Entity
• EventSourceable
• Process

Index

Properties

• state
• status

Methods

• [ROLLBACK_STATE_METHOD_KEY]
• [SAVE_STATE_METHOD_KEY]
• equals
• getId
• getLegacyTransformer
• getLegacyTransformers
• getPropTypes
• getPropertyInitializers
• getSchemaVersion
• getSelectableStates
• getSelectableStatuses
• getState
• getStatus
• getTypeName
• hasLegacyTransformer
• hasState
• hasStatus
• isInOneOfStates
• isInOneOfStatuses
• isInState
• isInStatus
• isStateSaved
• on
• overrideLegacyTransformer
• registerLegacyTransformer
• setState
• setStatus
• toPlainObject
• toString
• transformLegacyProps
• validateProps
• validateState
• validateStatus

Properties

state

• state: State

Inherited from Stateful.state

Overrides void

---

status

• status: Status

Inherited from Statusful.status

Overrides void

Methods

[ROLLBACK_STATE_METHOD_KEY]

▸ [ROLLBACK_STATE_METHOD_KEY](): void

Returns: void

▸ [ROLLBACK_STATE_METHOD_KEY](): void

Returns: void

---

[SAVE_STATE_METHOD_KEY]

▸ [SAVE_STATE_METHOD_KEY](): void

Returns: void

▸ [SAVE_STATE_METHOD_KEY](): void

Returns: void

---

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides Definable.equals

Parameters:

Name	Type
other	any

Returns: boolean

---

getId

▸ getId(): string | Stringifiable

Inherited from Identifiable.getId

Overrides void

Returns: string | Stringifiable

---

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Inherited from Versionable.getLegacyTransformer

Overrides Versionable.getLegacyTransformer

Parameters:

Name	Type
schemaVersion	number

Returns: Hook

---

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Inherited from Versionable.getLegacyTransformers

Overrides Versionable.getLegacyTransformers

Returns: LegacyTransformers

---

getPropTypes

▸ getPropTypes(): Record‹keyof any, any›

Inherited from Definable.getPropTypes

Overrides Definable.getPropTypes

Returns: Record‹keyof any, any›

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from Definable.getPropertyInitializers

Overrides Definable.getPropertyInitializers

Returns: Props

---

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Inherited from Versionable.getSchemaVersion

Overrides Versionable.getSchemaVersion

Returns: number | undefined

---

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Inherited from Stateful.getSelectableStates

Overrides void

Returns: Record‹string, State›

---

getSelectableStatuses

▸ getSelectableStatuses(): Record‹string, Status›

Inherited from Statusful.getSelectableStatuses

Overrides void

Returns: Record‹string, Status›

---

getState

▸ getState(): State

Inherited from Stateful.getState

Overrides void

Returns: State

---

getStatus

▸ getStatus(): Status

Inherited from Statusful.getStatus

Overrides void

Returns: Status

---

getTypeName

▸ getTypeName(): TypeName

Inherited from Serializable.getTypeName

Overrides Serializable.getTypeName

Returns: TypeName

---

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Inherited from Versionable.hasLegacyTransformer

Overrides Versionable.hasLegacyTransformer

Parameters:

Name	Type
schemaVersion	number

Returns: boolean

---

hasState

▸ hasState(): boolean

Inherited from Stateful.hasState

Overrides void

Returns: boolean

---

hasStatus

▸ hasStatus(): boolean

Inherited from Statusful.hasStatus

Overrides void

Returns: boolean

---

isInOneOfStates

▸ isInOneOfStates(states: State | State[]): boolean

Inherited from Stateful.isInOneOfStates

Overrides void

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInOneOfStatuses

▸ isInOneOfStatuses(status: Status | Status[]): boolean

Inherited from Statusful.isInOneOfStatuses

Overrides void

Parameters:

Name	Type
status	Status | Status[]

Returns: boolean

---

isInState

▸ isInState(state: State | State[]): boolean

Inherited from Stateful.isInState

Overrides void

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

isInStatus

▸ isInStatus(status: Status | Status[]): boolean

Inherited from Statusful.isInStatus

Overrides void

Parameters:

Name	Type
status	Status | Status[]

Returns: boolean

---

isStateSaved

▸ isStateSaved(): boolean

Returns: boolean

▸ isStateSaved(): boolean

Returns: boolean

---

on

▸ on(action: string | Stringifiable): any

Parameters:

Name	Type
action	string | Stringifiable

Returns: any

▸ on(action: string | Stringifiable): any

Parameters:

Name	Type
action	string | Stringifiable

Returns: any

---

overrideLegacyTransformer

▸ overrideLegacyTransformer(schemaVersion: number, transformer: Hook): void

Inherited from Versionable.overrideLegacyTransformer

Overrides Versionable.overrideLegacyTransformer

Parameters:

Name	Type
schemaVersion	number
transformer	Hook

Returns: void

---

registerLegacyTransformer

▸ registerLegacyTransformer(schemaVersion: number, transformer: Hook, shouldOverride: boolean): void

Inherited from Versionable.registerLegacyTransformer

Overrides Versionable.registerLegacyTransformer

Parameters:

Name	Type
schemaVersion	number
transformer	Hook
shouldOverride	boolean

Returns: void

---

setState

▸ setState(state: State): void

Inherited from Stateful.setState

Overrides void

Parameters:

Name	Type
state	State

Returns: void

---

setStatus

▸ setStatus(status: Status): void

Inherited from Statusful.setStatus

Overrides void

Parameters:

Name	Type
status	Status

Returns: void

---

toPlainObject

▸ toPlainObject(): Props

Inherited from Definable.toPlainObject

Overrides Definable.toPlainObject

Returns: Props

---

toString

▸ toString(): TypeName | string

Inherited from Serializable.toString

Overrides Serializable.toString

Returns: TypeName | string

---

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Inherited from Versionable.transformLegacyProps

Overrides Versionable.transformLegacyProps

Parameters:

Name	Type
props	Props

Returns: Props

---

validateProps

▸ validateProps(props: Props, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from Definable.validateProps

Overrides Definable.validateProps

Parameters:

Name	Type
props	Props
propTypes	PropTypes
isStrict?	boolean

Returns: boolean

---

validateState

▸ validateState(stateOrStates: State | State[], error?: Error): boolean

Inherited from Stateful.validateState

Overrides void

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean

---

validateStatus

▸ validateStatus(statusOrStatuses: Status | Status[], error?: Error): boolean

Inherited from Statusful.validateStatus

Overrides void

Parameters:

Name	Type
statusOrStatuses	Status | Status[]
error?	Error

Returns: boolean