@eveble/eveble

Hierarchy

↳ Serializable

• Stateful

• Serializable

• Stateful

  ↳ CommitReceiver

Implemented by

• CommitReceiver

Index

Properties

• appId
• failedAt
• publishedAt
• receivedAt
• state
• workerId

Methods

• equals
• flagAsFailed
• flagAsPublished
• flagAsReceived
• flagAsTimeouted
• getLegacyTransformer
• getLegacyTransformers
• getPropTypes
• getPropertyInitializers
• getSchemaVersion
• getSelectableStates
• getState
• getTypeName
• hasLegacyTransformer
• hasState
• isInOneOfStates
• isInState
• overrideLegacyTransformer
• registerLegacyTransformer
• setState
• toPlainObject
• toString
• transformLegacyProps
• validateProps
• validateState

Properties

appId

• appId: string

---

Optional failedAt

• failedAt? : Date

---

Optional publishedAt

• publishedAt? : Date

---

receivedAt

• receivedAt: Date

---

state

• state: State

Overrides Stateful.state

---

Optional workerId

• workerId? : string

Methods

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

Name	Type
other	any

Returns: boolean

---

flagAsFailed

▸ flagAsFailed(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

▸ flagAsFailed(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

---

flagAsPublished

▸ flagAsPublished(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

▸ flagAsPublished(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

---

flagAsReceived

▸ flagAsReceived(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

▸ flagAsReceived(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

---

flagAsTimeouted

▸ flagAsTimeouted(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

▸ flagAsTimeouted(workerId: string | Stringifiable): void

Parameters:

Name	Type
workerId	string | Stringifiable

Returns: void

---

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Inherited from Versionable.getLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number

Returns: Hook

---

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Inherited from Versionable.getLegacyTransformers

Overrides void

Returns: LegacyTransformers

---

getPropTypes

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

Inherited from Definable.getPropTypes

Overrides void

Returns: Record‹keyof any, any›

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from Definable.getPropertyInitializers

Overrides void

Returns: Props

---

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Inherited from Versionable.getSchemaVersion

Overrides void

Returns: number | undefined

---

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Inherited from Stateful.getSelectableStates

Overrides void

Returns: Record‹string, State›

---

getState

▸ getState(): State

Inherited from Stateful.getState

Overrides void

Returns: State

---

getTypeName

▸ getTypeName(): TypeName

Inherited from Serializable.getTypeName

Overrides void

Returns: TypeName

---

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Inherited from Versionable.hasLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number

Returns: boolean

---

hasState

▸ hasState(): boolean

Inherited from Stateful.hasState

Overrides void

Returns: boolean

---

isInOneOfStates

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

Inherited from Stateful.isInOneOfStates

Overrides void

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInState

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

Inherited from Stateful.isInState

Overrides void

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

overrideLegacyTransformer

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

Inherited from Versionable.overrideLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number
transformer	Hook

Returns: void

---

registerLegacyTransformer

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

Inherited from Versionable.registerLegacyTransformer

Overrides void

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

---

toPlainObject

▸ toPlainObject(): Props

Inherited from Definable.toPlainObject

Overrides void

Returns: Props

---

toString

▸ toString(): TypeName | string

Inherited from Serializable.toString

Overrides void

Returns: TypeName | string

---

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Inherited from Versionable.transformLegacyProps

Overrides void

Parameters:

Name	Type
props	Props

Returns: Props

---

validateProps

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

Inherited from Definable.validateProps

Overrides void

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