Skip to main content

service/domain/workflow/workflowitem_updated

Api Code Documentation / Exports / service/domain/workflow/workflowitem_updated

Table of contents#

Interfaces#

Variables#

Functions#

Variables#

modificationSchema#

Const modificationSchema: ObjectSchema

Defined in#

src/service/domain/workflow/workflowitem_updated.ts:29


schema#

Const schema: ObjectSchema

Defined in#

src/service/domain/workflow/workflowitem_updated.ts:53

Functions#

createEvent#

createEvent(source, publisher, projectId, subprojectId, workflowitemId, update, time?): Type<Event>

Parameters#

NameType
sourcestring
publisherstring
projectIdstring
subprojectIdstring
workflowitemIdstring
updateModification
timestring

Returns#

Type<Event>

Defined in#

src/service/domain/workflow/workflowitem_updated.ts:64


mutate#

mutate(workflowitem, event): Type<void>

Applies the event to the given workflowitem, or returns an error.

When an error is returned (or thrown), any already applied modifications are discarded.

This function is not expected to validate its changes; instead, the modified workflowitem is automatically validated when obtained using workflowitem_eventsourcing.ts:newWorkflowitemFromEvent.

Parameters#

NameType
workflowitemWorkflowitem
eventEvent

Returns#

Type<void>

Defined in#

src/service/domain/workflow/workflowitem_updated.ts:108


validate#

validate(input): Type<Event>

Parameters#

NameType
inputany

Returns#

Type<Event>

Defined in#

src/service/domain/workflow/workflowitem_updated.ts:93