AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Type Alias PropagatedEvent<SourceTopic, TargetTopic, Event>

    PropagatedEvent: Event extends { type: string }
        ? Event["type"] extends "close-requested"
            ? never
            : Omit<Event, "type" | "topic"> & {
                topic: TargetTopic;
                type: OpenFin.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.

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

    Settings