Interface EventFluentBuilder<TPayload>

id

build

• build(): IEvent<TPayload>

  Returns IEvent<TPayload>

meta

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

  Type Parameters

  • TNewMeta extends IEventMeta

  Parameters

  • m: TNewMeta

  Returns EventFluentBuilder<TPayload>

parallel

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

  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>

payloadSchema

• payloadSchema<TNew>(schema: IValidationSchema<TNew>): EventFluentBuilder<TNew>

  Type Parameters

  • TNew

  Parameters

  • schema: IValidationSchema<TNew>

  Returns EventFluentBuilder<TNew>

schema

• schema<TNew>(schema: IValidationSchema<TNew>): EventFluentBuilder<TNew>

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

  Type Parameters

  • TNew

  Parameters

  • schema: IValidationSchema<TNew>

  Returns EventFluentBuilder<TNew>

tags

• tags<TNewTags extends TagType[]>(
      t: TNewTags,
      options?: { override?: boolean },
  ): EventFluentBuilder<TPayload>

  Type Parameters

  • TNewTags extends TagType[]

  Parameters

  • t: TNewTags
  • Optionaloptions: { override?: boolean }

  Returns EventFluentBuilder<TPayload>

throws

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

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

  Parameters

  • list: ThrowsList

  Returns EventFluentBuilder<TPayload>