service/domain/document/document_validated

Api Code Documentation / Exports / service/domain/document/document_validated

Table of contents

Interfaces

• Event

Variables

• schema

Functions

• createEvent
• mutate
• validate

Variables

schema

• Const schema: ObjectSchema<any>

Defined in

src/service/domain/document/document_validated.ts:27

Functions

createEvent

▸ createEvent(isDocumentValid, documentId, source, publisher, projectId, subprojectId, workflowitemId, time?, metadata?): Type<Event>

Parameters

Name	Type
isDocumentValid	boolean
documentId	string
source	string
publisher	string
projectId	string
subprojectId	string
workflowitemId	string
time	string
metadata?	UserMetadata

Returns

Type<Event>

Defined in

src/service/domain/document/document_validated.ts:40

---

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/document/document_validated.ts:85

---

validate

▸ validate(input): Type<Event>

Parameters

Name	Type
input	any

Returns

Type<Event>

Defined in

src/service/domain/document/document_validated.ts:70