CommitReceiver

Type parameters

▪ T: SuperConstructor

Hierarchy

SuperPrototypeSelector‹StatefulMixin | Serializable, this› & StatefulMixin‹this› & Serializable‹this›
SuperPrototypeSelector‹Serializable | StatefulMixin, this› & StatefulMixin‹this› & Serializable‹this›
↳ CommitReceiver

Implements

Stateful
Definable
Hookable
Ejsonable
CommitReceiver
Stateful
Definable
Hookable
Ejsonable
CommitReceiver

Index

Constructors

constructor

Properties

Methods

Object literals

STATES

Constructors

constructor

+ new CommitReceiver(props?: Props): CommitReceiver

Overrides Serializable.constructor

Creates an instance of Serializable. Creates an instance of Serializable.

remarks Since were dealing with special cases, mixins and limits of TypeScript, we use of "invoking multiple base constructors" from polytype to pass props to Struct's constructor: https://www.npmjs.com/package/polytype#invoking-multiple-base-constructors

Parameters:

Name	Type	Description
`props?`	Props	Properties of the type required for construction.

Returns: CommitReceiver

Properties

appId

• appId: string

Implementation of CommitReceiver.appId

`Optional` failedAt

• failedAt? : Date

Implementation of CommitReceiver.failedAt

`Optional` publishedAt

• publishedAt? : Date

Implementation of CommitReceiver.publishedAt

receivedAt

• receivedAt: Date

Implementation of CommitReceiver.receivedAt

`Optional` schemaVersion

• schemaVersion? : number

Inherited from Serializable.schemaVersion

Overrides VersionableMixin.schemaVersion

state

• state: State

Implementation of CommitReceiver.state

Overrides StatefulMixin.state

`Optional` workerId

• workerId? : string

Implementation of CommitReceiver.workerId

Methods

equals

▸ equals(other: any): boolean

Implementation of CommitReceiver

Inherited from DefinableMixin.equals

Overrides CreateEmployee.equals

Parameters:

Name	Type
`other`	any

Returns: boolean

flagAsFailed

▸ flagAsFailed(workerId: string): void

Flags that commit failed(is not publishable on application).

Parameters:

Name	Type	Description
`workerId`	string	Identifier of worker that failed to publish `Commit`.

Returns: void

flagAsPublished

▸ flagAsPublished(workerId: string): void

Flags that commit is published on application.

Parameters:

Name	Type	Description
`workerId`	string	Identifier of worker that published `Commit`.

Returns: void

flagAsReceived

▸ flagAsReceived(workerId: string): void

Flags that commit is received by application.

Parameters:

Name	Type	Description
`workerId`	string	Identifier of worker that received `Commit`.

Returns: void

flagAsTimeouted

▸ flagAsTimeouted(workerId: string): void

Flags that commit was not published do to timeout on application.

Parameters:

Name	Type	Description
`workerId`	string	Identifier of worker on which `Commit` timeout.

Returns: void

getActions

▸ getActions(): Actions

Implementation of Hookable

Inherited from HookableMixin.getActions

Overrides CreateEmployee.getActions

Returns: Actions

getCurrentTime

▸ getCurrentTime(): Date

Returns current time.

Returns: Date

Instance of Date.

getHook

▸ getHook(action: string, id: string): Hook | undefined

Implementation of Hookable

Inherited from HookableMixin.getHook

Overrides CreateEmployee.getHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: Hook | undefined

getHookOrThrow

▸ getHookOrThrow(action: string, id: string): Hook

Implementation of Hookable

Inherited from HookableMixin.getHookOrThrow

Overrides CreateEmployee.getHookOrThrow

Parameters:

Name	Type
`action`	string
`id`	string

Returns: Hook

getHooks

▸ getHooks(action: string): Mappings

Implementation of Hookable

Inherited from HookableMixin.getHooks

Overrides CreateEmployee.getHooks

Parameters:

Name	Type
`action`	string

Returns: Mappings

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Implementation of CommitReceiver

Inherited from VersionableMixin.getLegacyTransformer

Overrides CreateEmployee.getLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: Hook

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Implementation of CommitReceiver

Inherited from VersionableMixin.getLegacyTransformers

Overrides CreateEmployee.getLegacyTransformers

Returns: LegacyTransformers

getPropTypes

▸ getPropTypes(): Props

Implementation of CommitReceiver

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of CommitReceiver

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Implementation of CommitReceiver

Inherited from VersionableMixin.getSchemaVersion

Overrides CreateEmployee.getSchemaVersion

Returns: number | undefined

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Implementation of CommitReceiver

Inherited from StatefulMixin.getSelectableStates

Overrides Task.getSelectableStates

Returns: Record‹string, State›

getState

▸ getState(): State

Implementation of CommitReceiver

Inherited from StatefulMixin.getState

Overrides Task.getState

Returns: State

getTypeName

▸ getTypeName(): TypeName

Implementation of CommitReceiver

Inherited from SerializableMixin.getTypeName

Overrides CreateEmployee.getTypeName

Returns: TypeName

hasAction

▸ hasAction(action: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasAction

Overrides CreateEmployee.hasAction

Parameters:

Name	Type
`action`	string

Returns: boolean

hasHook

▸ hasHook(action: string, id: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasHook

Overrides CreateEmployee.hasHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: boolean

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Implementation of CommitReceiver

Inherited from VersionableMixin.hasLegacyTransformer

Overrides CreateEmployee.hasLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: boolean

hasState

▸ hasState(): boolean

Implementation of CommitReceiver

Inherited from StatefulMixin.hasState

Overrides Task.hasState

Returns: boolean

in

▸ in‹T›(listName: string): List‹T›

Inherited from Serializable.in

Overrides CreateEmployee.in

Type parameters:

▪ T

Parameters:

Name	Type
`listName`	string

Returns: List‹T›

isInOneOfStates

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

Implementation of CommitReceiver

Inherited from StatefulMixin.isInOneOfStates

Overrides Task.isInOneOfStates

Parameters:

Name	Type
`states`	State \| State[]

Returns: boolean

isInState

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

Implementation of CommitReceiver

Inherited from StatefulMixin.isInState

Overrides Task.isInState

Parameters:

Name	Type
`state`	State \| State[]

Returns: boolean

overrideHook

▸ overrideHook(action: string, id: string, hook: Hook): void

Implementation of Hookable

Inherited from HookableMixin.overrideHook

Overrides CreateEmployee.overrideHook

Parameters:

Name	Type
`action`	string
`id`	string
`hook`	Hook

Returns: void

overrideLegacyTransformer

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

Implementation of CommitReceiver

Inherited from VersionableMixin.overrideLegacyTransformer

Overrides CreateEmployee.overrideLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number
`transformer`	Hook

Returns: void

processSerializableList

▸ processSerializableList(props?: Props): Props

Inherited from Serializable.processSerializableList

Overrides CreateEmployee.processSerializableList

Parameters:

Name	Type
`props?`	Props

Returns: Props

registerHook

▸ registerHook(action: string, id: string, hook: Hook, shouldOverride?: boolean): void

Implementation of Hookable

Inherited from HookableMixin.registerHook

Overrides CreateEmployee.registerHook

Parameters:

Name	Type
`action`	string
`id`	string
`hook`	Hook
`shouldOverride?`	boolean

Returns: void

registerLegacyTransformer

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

Implementation of CommitReceiver

Inherited from VersionableMixin.registerLegacyTransformer

Overrides CreateEmployee.registerLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number
`transformer`	Hook
`shouldOverride?`	boolean

Returns: void

removeHook

▸ removeHook(action: string, id: string): void

Implementation of Hookable

Inherited from HookableMixin.removeHook

Overrides CreateEmployee.removeHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: void

setState

▸ setState(state: State): void

Implementation of CommitReceiver

Inherited from StatefulMixin.setState

Overrides Task.setState

Parameters:

Name	Type
`state`	State

Returns: void

toJSONValue

▸ toJSONValue(): Record‹string, any›

Implementation of Ejsonable

Inherited from SerializableMixin.toJSONValue

Overrides CreateEmployee.toJSONValue

Returns: Record‹string, any›

toPlainObject

▸ toPlainObject(): Props

Implementation of CommitReceiver

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

toString

▸ toString(): TypeName

Implementation of CommitReceiver

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Implementation of CommitReceiver

Inherited from VersionableMixin.transformLegacyProps

Overrides CreateEmployee.transformLegacyProps

Parameters:

Name	Type
`props`	Props

Returns: Props

typeName

▸ typeName(): TypeName

Implementation of Ejsonable

Inherited from EjsonableMixin.typeName

Overrides CreateEmployee.typeName

Returns: TypeName

validateProps

▸ validateProps(props: Record‹string | number | symbol, any› | undefined, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from DefinableMixin.validateProps

Overrides CreateEmployee.validateProps

Parameters:

Name	Type
`props`	Record‹string \| number \| symbol, any› \| undefined
`propTypes`	PropTypes
`isStrict?`	boolean

Returns: boolean

validateState

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

Implementation of CommitReceiver

Inherited from StatefulMixin.validateState

Overrides Task.validateState

Parameters:

Name	Type
`stateOrStates`	State \| State[]
`error?`	Error

Returns: boolean

`Static` disableSerializableLists

▸ disableSerializableLists(): void

Inherited from Serializable.disableSerializableLists

Overrides CreateEmployee.disableSerializableLists

Returns: void

`Static` enableSerializableLists

▸ enableSerializableLists(): void

Inherited from Serializable.enableSerializableLists

Overrides CreateEmployee.enableSerializableLists

Returns: void

`Static` from

▸ from(...sources: Record‹string, any›[]): any

Inherited from Serializable.from

Overrides CreateEmployee.from

Parameters:

Name	Type
`...sources`	Record‹string, any›[]

Returns: any

`Static` getPropTypes

▸ getPropTypes(): Props

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

`Static` getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

`Static` getTypeName

▸ getTypeName(): TypeName

Inherited from SerializableMixin.getTypeName

Overrides CreateEmployee.getTypeName

Returns: TypeName

`Static` toString

▸ toString(): TypeName

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

`Static` typeName

▸ typeName(): TypeName

Inherited from EjsonableMixin.typeName

Overrides CreateEmployee.typeName

Returns: TypeName

Object literals

`Static` STATES

▪ STATES: object

failed

• failed: string = "failed"

published

• published: string = "published"

received

• received: string = "received"

timeouted

• timeouted: string = "timeouted"

Type parameters#

Hierarchy#

Implements#

Index#

Constructors#

Properties#

Methods#

Object literals#

Constructors#

constructor#

Properties#

appId#

Optional failedAt#

Optional publishedAt#

receivedAt#

Optional schemaVersion#

state#

Optional workerId#

Methods#

equals#

flagAsFailed#

flagAsPublished#

flagAsReceived#

flagAsTimeouted#

getActions#

getCurrentTime#

getHook#

getHookOrThrow#

getHooks#

getLegacyTransformer#

getLegacyTransformers#

getPropTypes#

getPropertyInitializers#

getSchemaVersion#

getSelectableStates#

getState#

getTypeName#

hasAction#

hasHook#

hasLegacyTransformer#

hasState#

in#

isInOneOfStates#

isInState#

overrideHook#

overrideLegacyTransformer#

processSerializableList#

registerHook#

registerLegacyTransformer#

removeHook#

setState#

toJSONValue#

toPlainObject#

toString#

transformLegacyProps#

typeName#

validateProps#

validateState#

Static disableSerializableLists#

Static enableSerializableLists#

Static from#

Static getPropTypes#

Static getPropertyInitializers#

Static getTypeName#

Static toString#

Static typeName#

Object literals#

Static STATES#

▪ STATES: object#

failed#

published#

received#

timeouted#

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

appId

`Optional` failedAt

`Optional` publishedAt

receivedAt

`Optional` schemaVersion

state

`Optional` workerId

Methods

equals

flagAsFailed

flagAsPublished

flagAsReceived

flagAsTimeouted

getActions

getCurrentTime

getHook

getHookOrThrow

getHooks

getLegacyTransformer

getLegacyTransformers

getPropTypes

getPropertyInitializers

getSchemaVersion

getSelectableStates

getState

getTypeName

hasAction

hasHook

hasLegacyTransformer

hasState

in

isInOneOfStates

isInState

overrideHook

overrideLegacyTransformer

processSerializableList

registerHook

registerLegacyTransformer

removeHook

setState

toJSONValue

toPlainObject

toString

transformLegacyProps

typeName

validateProps

validateState

`Static` disableSerializableLists

`Static` enableSerializableLists

`Static` from

`Static` getPropTypes

`Static` getPropertyInitializers

`Static` getTypeName

`Static` toString

`Static` typeName

Object literals

`Static` STATES

▪ STATES: object

failed

published

received

timeouted