arvo-event-handler
    Preparing search index...

    Type Alias EnqueueArvoEventActionParam<TData, TType, TExtension>

    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 EnqueueArvoEventActionParam<
        TData extends ArvoEventData = ArvoEventData,
        TType extends string = string,
        TExtension extends CloudEventExtension = CloudEventExtension,
    > = {
        __extensions?: TExtension;
        accesscontrol?: string;
        data: TData;
        dataschema?: string;
        domain?: NonEmptyArray<string | null>;
        executionunits?: number;
        id?: CreateArvoEvent<TData, TType>["id"];
        redirectto?: string;
        to?: string;
        type: TType;
    }

    Type Parameters

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

    Properties

    __extensions? accesscontrol? data dataschema? domain? executionunits? id? redirectto? to? type

    Properties

    Optional__extensions

    __extensions?: TExtension

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

    accesscontrol?: 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.

    dataschema?: string

    Identifies the schema that the data adheres to.

    domain?: NonEmptyArray<string | null>

    The domain configuration for multi-domain event broadcasting.

    executionunits?: number

    Represents the cost associated with generating the cloudevent.

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

    The event id

    redirectto?: string

    Indicates alternative recipients or destinations for events.

    to?: 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

    On This Page

    Properties