editor › Globals › PipelineEventsEmitter

Class: PipelineEventsEmitter

This class is removing some duplicate code from classes that want to emit a certain set of events and also listen for the same events and then forward the event. The events are - "progress" events are emitted with a Number in [0, 1], signalling the current progress - "warning" events are emitted with {code: String, message: String} - "stage" events are emitted with a String describing the current stage the export is at

Hierarchy

• PipelineEventsEmitter

↳ Nester

↳ SvgCreator

Index

Properties

• hintEventEmitter
• progressEventEmitter
• warningEventEmitter

Methods

• _onHint
• _onProgress
• _onWarning
• getHintEventEmitter
• getProgressEventEmitter
• getWarningEventEmitter

Properties

Protected Readonly hintEventEmitter

• hintEventEmitter: EventEmitter‹object› = new EventEmitter<{ message: string; newExportSettings?; }>()

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:20

---

Protected Readonly progressEventEmitter

• progressEventEmitter: EventEmitter‹object› = new EventEmitter<{ stage: string; progress: number; }>()

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:12

---

Protected Readonly warningEventEmitter

• warningEventEmitter: EventEmitter‹object› = new EventEmitter<{ code: string; message: string; }>()

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:16

Methods

Protected _onHint

▸ _onHint(hint: any): void

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:45

Parameters:

Name	Type
hint	any

Returns: void

---

Protected _onProgress

▸ _onProgress(args: object): void

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:37

Parameters:

▪ args: object

Name	Type
progress	number
stage	string

Returns: void

---

Protected _onWarning

▸ _onWarning(warning: object): void

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:41

Parameters:

▪ warning: object

Name	Type
code	string
message	string

Returns: void

---

getHintEventEmitter

▸ getHintEventEmitter(): IPublicEventEmitterInterface‹object›

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:33

Returns: IPublicEventEmitterInterface‹object›

---

getProgressEventEmitter

▸ getProgressEventEmitter(): IPublicEventEmitterInterface‹object›

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:25

Returns: IPublicEventEmitterInterface‹object›

---

getWarningEventEmitter

▸ getWarningEventEmitter(): IPublicEventEmitterInterface‹object›

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:29

Returns: IPublicEventEmitterInterface‹object›