Class Event

Represents an event within the system, containing all necessary metadata and subscriptions related to the event.

Hierarchy

Event

Implements

IEventJson

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Event(__namedParameters: { appName: string; eventFilePath: string; eventName: string; eventTime: string; eventType: EventTypes; subscriptions: FSWatcher[] }): Event

- Defined in @zowe/imperative/src/events/src/Event.ts:26
Initializes a new instance of the Event class with specified properties.

Parameters
- __namedParameters: { appName: string; eventFilePath: string; eventName: string; eventTime: string; eventType: EventTypes; subscriptions: FSWatcher[] }
  - appName: string
  - eventFilePath: string
  - eventName: string
  - eventTime: string
  - eventType: EventTypes
  - subscriptions: FSWatcher[]
Returns Event

Properties

appName

appName: string

eventFilePath

eventFilePath: string

eventName

eventName: string

eventTime

eventTime: string

eventType

eventType: EventTypes

subscriptions

subscriptions: FSWatcher[]

Methods

toJson

toJson(): IEventJson

- Defined in @zowe/imperative/src/events/src/Event.ts:48
Serializes the Event object to a JSON object for storage or transmission.

Returns IEventJson

The JSON representation of the event.

toString

toString(): string

- Defined in @zowe/imperative/src/events/src/Event.ts:63
Provides a string representation of the Event, useful for logging and debugging.

Returns string

A string detailing the event's significant information.

Generated using TypeDoc