@sourceloop/bpmn-service / Exports / WorkflowController

Class: WorkflowController

Table of contents

Constructors

• constructor

Properties

• execInputValidator
• workerFn
• workerMapGetter
• workflowManagerService
• workflowRepository
• workflowVersionRepository

Methods

• count
• create
• deleteById
• deleteVersionById
• find
• initWorkers
• startWorkflow
• updateById

Constructors

constructor

• new WorkflowController(workflowRepository, workflowVersionRepository, workflowManagerService, execInputValidator, workerMapGetter, workerFn)

Parameters

Name	Type
workflowRepository	WorkflowRepository
workflowVersionRepository	WorkflowVersionRepository
workflowManagerService	WorflowManager<AnyObject, AnyObject>
execInputValidator	ExecutionInputValidator<AnyObject>
workerMapGetter	Getter<WorkerMap<AnyObject, AnyObject>>
workerFn	WorkerImplementationFn<AnyObject, AnyObject>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:42

Properties

execInputValidator

• Private Readonly execInputValidator: ExecutionInputValidator<AnyObject>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:50

---

workerFn

• Private Readonly workerFn: WorkerImplementationFn<AnyObject, AnyObject>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:54

---

workerMapGetter

• Private Readonly workerMapGetter: Getter<WorkerMap<AnyObject, AnyObject>>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:52

---

workflowManagerService

• Private Readonly workflowManagerService: WorflowManager<AnyObject, AnyObject>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:48

---

workflowRepository

• workflowRepository: WorkflowRepository

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:44

---

workflowVersionRepository

• workflowVersionRepository: WorkflowVersionRepository

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:46

Methods

count

▸ count(id): Promise<Workflow>

Parameters

Name	Type
id	string

Returns

Promise<Workflow>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:253

---

create

▸ create(workflowDto): Promise<Workflow>

Parameters

Name	Type
workflowDto	WorkflowDto

Returns

Promise<Workflow>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:57

---

deleteById

▸ deleteById(id): Promise<void>

Parameters

Name	Type
id	string

Returns

Promise<void>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:270

---

deleteVersionById

▸ deleteVersionById(id, versionNumber): Promise<void>

Parameters

Name	Type
id	string
versionNumber	number

Returns

Promise<void>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:296

---

find

▸ find(filter?): Promise<Workflow[]>

Parameters

Name	Type
filter?	Filter<Workflow>

Returns

Promise<Workflow[]>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:227

---

initWorkers

▸ Private initWorkers(workflowName): Promise<void>

Parameters

Name	Type
workflowName	string

Returns

Promise<void>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:341

---

startWorkflow

▸ startWorkflow(id, instance): Promise<AnyObject>

Parameters

Name	Type
id	string
instance	ExecuteWorkflowDto<AnyObject>

Returns

Promise<AnyObject>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:168

---

updateById

▸ updateById(workflowDto, id): Promise<void>

Parameters

Name	Type
workflowDto	WorkflowDto
id	string

Returns

Promise<void>

Defined in

services/bpmn-service/src/controllers/workflow.controller.ts:117