Class Message<T>

Type parameters

T

Hierarchy

Message

Index

Constructors

constructor

Properties

body
headers

Accessors

size

Methods

Constructors

constructor

new Message(messaging: Messaging, route: Route, originalMessage: AMessage): Message

- Defined in Message.ts:34
Parameters
- messaging: Messaging
- route: Route
- originalMessage: AMessage
Returns Message

Properties

body

body: T

headers

headers: any

Accessors

size

get size(): number

- Defined in Message.ts:32
Gets the size of the message in bytes

Returns number

Methods

ack

ack(): void

- Defined in Message.ts:80
Returns void

correlationId

correlationId(): any

- Defined in Message.ts:90
Returns any

destinationRoute

destinationRoute(): any

- Defined in Message.ts:94
Returns any

end

end(body?: any, headers?: MessageHeaders): Promise<void>

- Defined in Message.ts:101
Parameters
- Optional body: any
- Optional headers: MessageHeaders
Returns Promise<void>

error

error(): CustomError

- Defined in Message.ts:108
Converts the message to an Error

Returns CustomError

getSequence

getSequence(): any

- Defined in Message.ts:113
Returns any

isAnswer

isAnswer(): boolean

- Defined in Message.ts:117
Returns boolean

isChannelClosed

isChannelClosed(): boolean

- Defined in Message.ts:121
Returns boolean

isError

isError(): any

- Defined in Message.ts:125
Returns any

isEvent

isEvent(): boolean

- Defined in Message.ts:129
Returns boolean

isRequest

isRequest(): boolean

- Defined in Message.ts:133
Returns boolean

isStream

isStream(): boolean

- Defined in Message.ts:137
Returns boolean

isStreamEnd

isStreamEnd(): boolean

- Defined in Message.ts:141
Returns boolean

isTask

isTask(): boolean

- Defined in Message.ts:150
Return true is the message a task. Tasks do not expect answer, if it is expecting an answer then it's a request.

Returns boolean

nack

nack(): void

- Defined in Message.ts:154
Returns void

nativeReject

nativeReject(): void

- Defined in Message.ts:164
Returns void

originalMessage

originalMessage(): Message

- Defined in Message.ts:170
Returns Message

reject

reject(error: CustomError | any, headers?: MessageHeaders): Promise<void>

- Defined in Message.ts:174
Parameters
- error: CustomError | any
- Optional headers: MessageHeaders
Returns Promise<void>

reply

reply(body?: any, headers?: MessageHeaders): Promise<void>

- Defined in Message.ts:178
Parameters
- Optional body: any
- Optional headers: MessageHeaders
Returns Promise<void>

toJSON

toJSON(): object

- Defined in Message.ts:182
Returns object
- body: T
- fields: MessageFields
- properties: MessageProperties

write

write(body?: any, headers?: MessageHeaders): Promise<void>

- Defined in Message.ts:190
Parameters
- Optional body: any
- Optional headers: MessageHeaders
Returns Promise<void>

Static toBuffer

toBuffer(ref?: any): Promise<ToBuffer>

- Defined in Message.ts:43
Parameters
- Default value ref: any = ""
Returns Promise<ToBuffer>

Static toJSON

toJSON(message: AMessage): object

- Defined in Message.ts:72
Parameters
- message: AMessage
Returns object
- content: any
- fields: MessageFields
- properties: MessageProperties

Generated using TypeDoc