AboutSupportDeveloper GuideVersion 41.132.100.56

Type Alias PropagatedEvent<SourceTopic, TargetTopic, Event>

PropagatedEvent<SourceTopic, TargetTopic, Event>: Event extends {
        type: string;
    }
    ? Event["type"] extends "close-requested"
        ? never
        : Omit<Event, "type" | "topic"> & {
            topic: TargetTopic;
            type: OpenFin.Events.BaseEvents.PropagatedEventType<SourceTopic, Event["type"]>;
        }
    : never

Modifies an event shape to reflect propagation to a parent topic. Excludes close-requested events, as these do not propagate.

Type Parameters

  • SourceTopic extends string

    The topic the event shape is propagating from.

  • TargetTopic extends string

    The topic the event shape is propagating to.

  • Event extends {
        type: string;
    }

    The shape of the event being propagated.

Remarks

The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.

Settings