Class WorkflowEngineSignal

Сигнал в WorkflowEngine.

Hierarchy

StorageObject
- WorkflowEngineSignal

Implements

IWorkflowEngineSignal

Index

Constructors

constructor

new WorkflowEngineSignal(storage?: IStorage<unknown>): WorkflowEngineSignal
Parameters
- storage: IStorage<unknown> = {}
Returns WorkflowEngineSignal
Overrides StorageObject.constructor
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:9

Static Keys Properties

`Static` `Readonly` hashKey

hashKey: "Hash" = 'Hash'

`Static` `Readonly` ignoreSignalProcessingModeKey

ignoreSignalProcessingModeKey: "IgnoreSignalProcessingMode" = 'IgnoreSignalProcessingMode'

`Static` `Readonly` typeKey

typeKey: "Type" = 'Type'

Accessors

hash

get hash(): IStorage<unknown>
Дополнительные параметры сигнала.

Returns IStorage<unknown>
Implementation of IWorkflowEngineSignal.hash
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:41
set hash(value: IStorage<unknown>): void
Дополнительные параметры сигнала.
Parameters
- value: IStorage<unknown>
Returns void
Implementation of IWorkflowEngineSignal.hash
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:44

ignoreSignalProcessingMode

get ignoreSignalProcessingMode(): boolean
Определяет, что при обработке сигнала нужно игнорировать режим обработки сигнала, указанный в процессе.

Returns boolean
Implementation of IWorkflowEngineSignal.ignoreSignalProcessingMode
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:48
set ignoreSignalProcessingMode(value: boolean): void
Определяет, что при обработке сигнала нужно игнорировать режим обработки сигнала, указанный в процессе.
Parameters
- value: boolean
Returns void
Implementation of IWorkflowEngineSignal.ignoreSignalProcessingMode
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:54

type

get type(): string
Тип передаваемого сигнала.

Returns string
Implementation of IWorkflowEngineSignal.type
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:34
set type(value: string): void
Тип передаваемого сигнала.
Parameters
- value: string
Returns void
Implementation of IWorkflowEngineSignal.type
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:37

Methods

clean

clean(): void
Выполняет очистку хранилища от избыточных данных.

Returns void
Inherited from StorageObject.clean
- Defined in @tessa/core/src/storage/storageObject.ts:442

ensureCacheResolved

ensureCacheResolved(): void
Выполняет резолв кеша декораторов для данных объекта-хранилища.

Returns void
Inherited from StorageObject.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageObject.ts:448

getStorage

getStorage(): IStorage<unknown>
Метод для получения хранилища данных сигнала.

Returns IStorage<unknown>
Implementation of IWorkflowEngineSignal.getStorage

Inherited from StorageObject.getStorage
- Defined in @tessa/core/src/storage/storageObject.ts:434

getStorageSettings

getStorageSettings(): Readonly<StorageSettings>
Возвращает настройки объекта-хранилища.

Returns Readonly<StorageSettings>
Inherited from StorageObject.getStorageSettings
- Defined in @tessa/core/src/storage/storageObject.ts:468

notifyStorageUpdated

notifyStorageUpdated(): void
Метод, уведомляющий объект о наличии изменений в его хранилище.

Returns void
Inherited from StorageObject.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageObject.ts:454

tryGetHash

tryGetHash(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:62

`Static` create

create(type: string, hash?: null | IStorage<unknown>): WorkflowEngineSignal
Создаёт сигнал указанного типа.
Parameters
- type: string
- hash: null | IStorage<unknown> = null
Returns WorkflowEngineSignal
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:67

`Static` createDefaultSignal

createDefaultSignal(hash?: null | IStorage<unknown>): WorkflowEngineSignal
Создаёт сигнал типа WorkflowSignalTypes.Default.
Parameters
- hash: null | IStorage<unknown> = null
Returns WorkflowEngineSignal
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:75

`Static` createExitSignal

createExitSignal(): WorkflowEngineSignal
Создаёт сигнал типа WorkflowSignalTypes.Exit.

Returns WorkflowEngineSignal
- Defined in @tessa/platform/src/workflow/signals/workflowEngineSignal.ts:80

Class WorkflowEngineSignal

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns WorkflowEngineSignal

Static Keys Properties

Static Readonly hashKey

Static Readonly ignoreSignalProcessingModeKey

Static Readonly typeKey

Accessors

hash

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

ignoreSignalProcessingMode

Returns boolean

Parameters

value: boolean

Returns void

type

Returns string

Parameters

value: string

Returns void

Methods

clean

Returns void

ensureCacheResolved

Returns void

getStorage

Returns IStorage<unknown>

getStorageSettings

Returns Readonly<StorageSettings>

notifyStorageUpdated

Returns void

tryGetHash

Returns null | IStorage<unknown>

Static create

Parameters

type: string

hash: null | IStorage<unknown> = null

Returns WorkflowEngineSignal

Static createDefaultSignal

Parameters

hash: null | IStorage<unknown> = null

Returns WorkflowEngineSignal

Static createExitSignal

Returns WorkflowEngineSignal

`Static` `Readonly` hashKey

`Static` `Readonly` ignoreSignalProcessingModeKey

`Static` `Readonly` typeKey

`Static` create

`Static` createDefaultSignal

`Static` createExitSignal