Skip to content

Commit

Permalink
Update docs on send to match those of rhea (#40)
Browse files Browse the repository at this point in the history
* Update docs on send to match those of rhea

* Improved messaging

* Remove Azure specific codes
  • Loading branch information
ramya-rao-a authored Apr 29, 2019
1 parent 5c1a02e commit 13de0c6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions lib/sender.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,13 @@ export class Sender extends Link {

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

0 comments on commit 13de0c6

Please sign in to comment.