Skip to main content

Interface: AttachForwardedMetadataParams<TPayload>

Defined in: electron/utils/eventMetadataForwarding.ts:42

Parameters for attaching forwarded metadata to an event payload.

Type Parameters​

TPayload​

TPayload extends object

Properties​

busId​

busId: string

Defined in: electron/utils/eventMetadataForwarding.ts:44

Identifier of the event bus emitting the forwarded event.

forwardedEvent​

forwardedEvent: string

Defined in: electron/utils/eventMetadataForwarding.ts:46

Public event name that metadata should reflect.

payload​

payload: TPayload

Defined in: electron/utils/eventMetadataForwarding.ts:48

Payload being forwarded to renderer listeners.

source​

source: unknown

Defined in: electron/utils/eventMetadataForwarding.ts:50

Internal event payload that may contain metadata.