Skip to content

Commit cc3d33e

Browse files
Pchelolowebmakersteve
authored andcommitted
Updated JSDoc for Producer#produce (#60)
1 parent 877eeb6 commit cc3d33e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/producer.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,10 @@ Producer.prototype._produceObject = util.deprecate(function(message, cb) {
199199
* When this is sent off, there is no guarantee it is delivered. If you need
200200
* guaranteed delivery, change your *acks* settings, or use delivery reports.
201201
*
202-
* @param {Producer~Message} msg - The message object.
202+
* @param {string} topic - The topic name to produce to.
203+
* @param {number|null} partition - The partition number to produce to.
204+
* @param {Buffer|null} message - The message to produce.
205+
* @param {string} [key] - The key associated with the message.
203206
* @throws {LibrdKafkaError} - Throws a librdkafka error if it failed.
204207
* @return {boolean} - returns an error if it failed, or true if not
205208
* @see Producer#produce

0 commit comments

Comments
 (0)