Type Alias EnqueueArvoEventActionParam<TData, TType, TExtension>

EnqueueArvoEventActionParam<TData, TType, TExtension>: {
    __extensions?: TExtension;
    accesscontrol?: string;
    data: TData;
    dataschema?: string;
    domain?: (string | null)[];
    executionunits?: number;
    id?: CreateArvoEvent<TData, TType>["id"];
    redirectto?: string;
    to?: string;
    type: TType;
}

Represents the parameters for the emitArvoEvent action in ArvoXState. This type defines a subset of properties from the CreateArvoEvent type, specifically tailored for emitting an ArvoEvent within the state machine context.

Type Parameters

  • TData extends ArvoEventData = ArvoEventData
  • TType extends string = string
  • TExtension extends CloudEventExtension = CloudEventExtension

Type declaration

  • Optional__extensions?: TExtension

    Custom extensions for the CloudEvent. Allows for additional metadata to be attached to the event.

  • Optionalaccesscontrol?: string

    Defines access controls for the event. Can be a UserID, encrypted string, or key-value pairs.

  • data: TData

    The event payload. This payload must be JSON serializable.

  • Optionaldataschema?: string

    Identifies the schema that the data adheres to.

  • Optionaldomain?: (string | null)[]

    The domain configuration for multi-domain event broadcasting.

  • Optionalexecutionunits?: number

    Represents the cost associated with generating the cloudevent.

  • Optionalid?: CreateArvoEvent<TData, TType>["id"]

    The event id

  • Optionalredirectto?: string

    Indicates alternative recipients or destinations for events.

  • Optionalto?: string

    Defines the consumer machine of the event. Used for event routing. Must be a valid URI if present. If not available, the type field is used as a default.

  • type: TType

    Describes the type of event.

Settings

Member Visibility