Skip to content

Commit d1a7831

Browse files
add list formatting to API doc
1 parent 4e010e6 commit d1a7831

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ in your file
2626
## `AlAwsCollector`
2727
Base class for AWS lambda based collectors
2828

29-
@param {Object} context - context of Lambda's function.
30-
@param {string} collectorType - collector type (cwe as example).
31-
@param {string} ingestType - ingest data type (secmsgs, vpcflow, etc).
32-
@param {string} version - version of collector.
33-
@param {Object} aimsCreds - Alert Logic API credentials.
34-
@param {string} [aimsCreds.access_key_id] - Alert Logic API access key id.
35-
@param {string} [aimsCreds.secret_key] - Alert Logic API secret key.
36-
@param {function} formatFun - callback formatting function
37-
@param {Array.<function>} healthCheckFuns - list of custom health check functions (can be just empty, so only common are applied)
38-
@param {Array.<function>} statsFuns - list of custom stats functions (can be just empty, so only common are applied)
29+
* @param {Object} context - context of Lambdas function.
30+
* @param {string} collectorType - collector type (cwe as example).
31+
* @param {string} ingestType - ingest data type (secmsgs, vpcflow, etc).
32+
* @param {string} version - version of collector.
33+
* @param {Object} aimsCreds - Alert Logic API credentials.
34+
* @param {string} [aimsCreds.access_key_id] - Alert Logic API access key id.
35+
* @param {string} [aimsCreds.secret_key] - Alert Logic API secret key.
36+
* @param {function} formatFun - callback formatting function
37+
* @param {Array.<function>} healthCheckFuns - list of custom health check functions (can be just empty, so only common are applied)
38+
* @param {Array.<function>} statsFuns - list of custom stats functions (can be just empty, so only common are applied)
3939

4040
# Debugging
4141

0 commit comments

Comments
 (0)