Skip to content

Commit 13de0c6

Browse files
authored
Update docs on send to match those of rhea (#40)
* Update docs on send to match those of rhea * Improved messaging * Remove Azure specific codes
1 parent 5c1a02e commit 13de0c6

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

lib/sender.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,13 @@ export class Sender extends Link {
8989

9090
/**
9191
* Sends the message
92-
* @param {Message | Buffer} msg The AMQP message to be sent.
93-
* @param {Buffer | string} [tag] The optional tag that can be sent
94-
* @param {number} [format] The format in which the message needs to be sent.
92+
* @param {Message | Buffer} msg The message to be sent. For default AMQP format msg parameter
93+
* should be of type Message interface. For a custom format, the msg parameter should be a Buffer
94+
* and a valid value should be passed to the `format` argument.
95+
* @param {Buffer | string} [tag] The message tag if any.
96+
* @param {number} [format] The message format. Specify this if a message with custom format needs
97+
* to be sent. `0` implies the standard AMQP 1.0 defined format. If no value is provided, then the
98+
* given message is assumed to be of type Message interface and encoded appropriately.
9599
* @returns {Delivery} Delivery The delivery information about the sent message.
96100
*/
97101
send(msg: Message | Buffer, tag?: Buffer | string, format?: number): Delivery {

0 commit comments

Comments
 (0)