Function createCloudEvent

  • createCloudEvent(params): CloudEvent<Record<string, any>>

  • Creates a new CloudEvent based on the provided parameters. This function encapsulates the complexity of creating a CloudEvent by setting up necessary fields and encoding data.

    Parameters

    • params: ICreateCloudEvent

      An object conforming to the ICreateCloudEvent interface, providing the necessary information to create a CloudEvent.

    Returns CloudEvent<Record<string, any>>

    A new instance of CloudEvent, which is a standardized event format for describing event data in a common way.

    The CloudEvent instance includes:

    • source: A URI reference that uniquely identifies the origin of the event.
    • datacontenttype: Set to "application/json" indicating the type of data included in the event.
    • data: The actual data relevant to the event, passed as part of the params.
    • subject: A string providing contextual information about the event.
    • type: The topic or category under which this event falls.

Generated using TypeDoc