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<any>
Defined in
src/service/domain/workflow/workflowitem_updated.ts:41
schema
• Const schema: ObjectSchema<any>
Defined in
src/service/domain/workflow/workflowitem_updated.ts:69
Functions
createEvent
▸ createEvent(source, publisher, projectId, subprojectId, workflowitemId, update, time?, metadata?): Type<Event>
Parameters
| Name | Type |
|---|---|
source | string |
publisher | string |
projectId | string |
subprojectId | string |
workflowitemId | string |
update | Modification |
time | string |
metadata? | UserMetadata |
Returns
Defined in
src/service/domain/workflow/workflowitem_updated.ts:81
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
| Name | Type |
|---|---|
workflowitem | Workflowitem |
event | Event |
Returns
Type<void>
Defined in
src/service/domain/workflow/workflowitem_updated.ts:127
validate
▸ validate(input): Type<Event>
Parameters
| Name | Type |
|---|---|
input | any |