Interface EventFluentBuilder<TPayload, TTransactional>

id

build

• build(): IEvent<TPayload> & { transactional?: TTransactional }

  Materializes the final event definition for registration or reuse.

  Returns IEvent<TPayload> & { transactional?: TTransactional }

meta

• meta<TNewMeta extends IEventMeta>(
      m: TNewMeta,
  ): EventFluentBuilder<TPayload, TTransactional>

  Attaches metadata used by docs and tooling.

  Type Parameters

  • TNewMeta extends IEventMeta

  Parameters

  • m: TNewMeta

  Returns EventFluentBuilder<TPayload, TTransactional>

parallel

• parallel(enabled?: boolean): EventFluentBuilder<TPayload, TTransactional>

  Enable parallel execution for this event's listeners. When enabled, listeners with the same order run concurrently within a batch. Batches execute sequentially in ascending order priority.

  Parameters

  • Optionalenabled: boolean

    Whether to enable parallel execution (default: true)

  Returns EventFluentBuilder<TPayload, TTransactional>

payloadSchema

• payloadSchema<
      TNew = never,
      TSchema extends
          ValidationSchemaInput<[TNew] extends [never] ? any : TNew> = ValidationSchemaInput<
          [TNew] extends [never] ? any : TNew,
      >,
  >(
      schema: TSchema,
  ): EventFluentBuilder<
      ResolveValidationSchemaInput<TNew, TSchema>,
      TTransactional,
  >

  Declares the event payload schema.

  Type Parameters

  • TNew = never
  • TSchema extends ValidationSchemaInput<[TNew] extends [never] ? any : TNew> = ValidationSchemaInput<[TNew] extends [never] ? any : TNew>

  Parameters

  • schema: TSchema

  Returns EventFluentBuilder<ResolveValidationSchemaInput<TNew, TSchema>, TTransactional>

schema

• schema<
      TNew = never,
      TSchema extends
          ValidationSchemaInput<[TNew] extends [never] ? any : TNew> = ValidationSchemaInput<
          [TNew] extends [never] ? any : TNew,
      >,
  >(
      schema: TSchema,
  ): EventFluentBuilder<
      ResolveValidationSchemaInput<TNew, TSchema>,
      TTransactional,
  >

  Alias for payloadSchema. Use this to define the event payload validation contract.

  Type Parameters

  • TNew = never
  • TSchema extends ValidationSchemaInput<[TNew] extends [never] ? any : TNew> = ValidationSchemaInput<[TNew] extends [never] ? any : TNew>

  Parameters

  • schema: TSchema

  Returns EventFluentBuilder<ResolveValidationSchemaInput<TNew, TSchema>, TTransactional>

tags

• tags<TNewTags extends EventTagType[]>(
      t: EnsureTagsForTarget<"events", TNewTags>,
      options?: { override?: boolean },
  ): EventFluentBuilder<TPayload, TTransactional>

  Adds or replaces event tags.

  Type Parameters

  • TNewTags extends EventTagType[]

  Parameters

  • t: EnsureTagsForTarget<"events", TNewTags>
  • Optionaloptions: { override?: boolean }

  Returns EventFluentBuilder<TPayload, TTransactional>

throws

• throws(list: ThrowsList): EventFluentBuilder<TPayload, TTransactional>

  Declare errors that hooks assigned to this event might throw. This is for documentation purposes only.

  Parameters

  • list: ThrowsList

  Returns EventFluentBuilder<TPayload, TTransactional>

transactional

• transactional<TEnabled extends boolean = true>(
      enabled?: TEnabled,
  ): EventFluentBuilder<TPayload, TEnabled>

  Enable transactional execution for this event's listeners. In transactional mode every listener must return an async undo closure.

  Type Parameters

  • TEnabled extends boolean = true

  Parameters

  • Optionalenabled: TEnabled

    Whether transactional mode is enabled (default: true)

  Returns EventFluentBuilder<TPayload, TEnabled>