Skip to content

Commit 3b94884

Browse files
author
Shakeel Mohamed
committed
Update docstrings
1 parent c7cdaee commit 3b94884

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

splunklogger.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ SplunkLogger.prototype._makeBody = function(context) {
345345
* next(null, context);
346346
* });
347347
*
348-
* @param {function} middleware - A middleware function: <code>function(context, next){}</code>.
348+
* @param {function} middleware - A middleware function: <code>function(context, next)</code>.
349349
* It must call <code>next(error, context)</code> to continue.
350350
* @public
351351
* @throws Will throw an error if <code>middleware</code> is not a <code>function</code>.
@@ -420,7 +420,7 @@ SplunkLogger.prototype._sendEvents = function(context, callback) {
420420
* severity: "info",
421421
* {
422422
* source: "chicken coop",
423-
* sourcetype: "chicken feeder",
423+
* sourcetype: "httpevent",
424424
* index: "main",
425425
* host: "farm.local",
426426
* }
@@ -430,7 +430,8 @@ SplunkLogger.prototype._sendEvents = function(context, callback) {
430430
* if (err) {
431431
* console.log("error:", err);
432432
* }
433-
* console.log("body", body); // body { text: 'Success', code: 0 }
433+
* // If successful, body will be { text: 'Success', code: 0 }
434+
* console.log("body", body);
434435
* });
435436
*
436437
* @param {object} context - An object with at least the <code>data</code> property.

0 commit comments

Comments
 (0)