arvo-core
    Preparing search index...

    Function createArvoEvent

    • Creates a strongly-typed ArvoEvent with configurable telemetry options.

      Type Parameters

      • TData extends Record<string, any>
      • TExtension extends Record<string, string | number | boolean | null>
      • TType extends string

      Parameters

      • event: CreateArvoEvent<TData, TType>

        Event configuration and data

      • Optionalextensions: TExtension

        Optional cloud event extensions

      • Optionalopentelemetry: { disable?: boolean }

        OpenTelemetry configuration with options:

        • disable - Completely disables telemetry if true

      Returns ArvoEvent<TData, TExtension, TType>

      ArvoEvent with type-safety

      In case any validation in ArvoEvent fails.

      // With default telemetry
      const event = createArvoEvent({
      type: 'order.created',
      source: '/orders',
      subject: 'order-123',
      data: orderData
      });

      // With disabled telemetry
      const event = createArvoEvent(
      {
      type: 'order.created',
      source: '/orders',
      subject: 'order-123',
      data: orderData
      },
      undefined,
      { disable: true }
      );