ResourceActionInformationTransactionEvent

This event is emitted pre-transaction to provide information for resource actions about to be executed in the transaction.

@group

Events/Transaction

@returns

The Event instance.

Hierarchy

• TransactionEvent<{ action: { name: string }; capture?: { response: Partial<BaseResourceSchema[response]> }; diff: DiffMetadata }>
  • ResourceActionInformationTransactionEvent

Index

Constructors

• constructor

Properties

• header
• name
• payload

Methods

• registrar

Constructors

constructor

• ResourceActionInformationTransactionEvent(name?: string, payload?: { action: { name: string }; capture?: { response: Partial<BaseResourceSchema[response]> }; diff: DiffMetadata }): ResourceActionInformationTransactionEvent

• Inherited from TransactionEvent.constructor

  Parameters

  • optionalname: string

  • optionalpayload: { action: { name: string }; capture?: { response: Partial<BaseResourceSchema[response]> }; diff: DiffMetadata }

  • action: { name: string }

  • optionalcapture: { response: Partial<BaseResourceSchema[response]> }

  • diff: DiffMetadata

  Returns ResourceActionInformationTransactionEvent

Properties

readonlyinheritedheader

header: { timestamp: number }

Inherited from TransactionEvent.header

Type declaration

• timestamp: number

readonlyinheritedname

name: string

Inherited from TransactionEvent.name

readonlyinheritedpayload

payload: { action: { name: string }; capture?: { response: Partial<BaseResourceSchema[response]> }; diff: DiffMetadata }

Inherited from TransactionEvent.payload

Type declaration

• action: { name: string }

  • name: string

• optionalcapture?: { response: Partial<BaseResourceSchema[response]> }

  • response: Partial<BaseResourceSchema[response]>

• diff: DiffMetadata

Methods

staticinheritedregistrar

• registrar(...args: [EventService, PropertyDescriptor]): void

• Inherited from TransactionEvent.registrar

  The registrar() method is explicitly called by the EventSource decorator for a method to enhance that method to auto-emit events.

  ---

  Parameters

  • rest...args: [EventService, PropertyDescriptor]

    Arguments are spread out using the array spread operator.

    • args[0] - Instance of EventService.
    • args[1] - PropertyDescriptor.

  Returns void