Interface: PreTurnContext
Makaio Framework / hooks / PreTurnContext
Interface: PreTurnContext
Section titled “Interface: PreTurnContext”Defined in: ../../../packages/hooks/src/types/hook-context.ts:164
Extends
Section titled “Extends”BaseHookContext<unknown>
Properties
Section titled “Properties”correlationId
Section titled “correlationId”
readonlycorrelationId:string|undefined
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:18
Inherited from
Section titled “Inherited from”BaseHookContext.correlationId
hookEvent
Section titled “hookEvent”
readonlyhookEvent:"PreTurn"
Defined in: ../../../packages/hooks/src/types/hook-context.ts:165
Hook event name
Overrides
Section titled “Overrides”BaseHookContext.hookEvent
messageId
Section titled “messageId”
readonlymessageId:string
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:17
Inherited from
Section titled “Inherited from”BaseHookContext.messageId
payload
Section titled “payload”
readonlypayload:unknown
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:16
Inherited from
Section titled “Inherited from”BaseHookContext.payload
subject
Section titled “subject”
readonlysubject:string
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:15
Inherited from
Section titled “Inherited from”BaseHookContext.subject
Methods
Section titled “Methods”next()
Section titled “next()”next():
void
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:36
Explicitly continue to the next interceptor (optional). Continuation is implicit if neither stopPropagation() nor next() is called.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseHookContext.next
replacePayload()
Section titled “replacePayload()”replacePayload(
newPayload):void
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:30
Replace the payload with a new value. Subsequent interceptors and handlers will receive the new payload.
Parameters
Section titled “Parameters”newPayload
Section titled “newPayload”unknown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseHookContext.replacePayload
stopPropagation()
Section titled “stopPropagation()”stopPropagation():
void
Defined in: ../../../packages/bus-core/src/types/interceptor.ts:24
Stop propagation of this message. Subsequent interceptors and all handlers will NOT be called.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseHookContext.stopPropagation