summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2017-08-13 01:02:34 -0600
committerLuke Shumaker <lukeshu@lukeshu.com>2017-08-13 01:02:34 -0600
commit0965a1b694b8312c89ca02f64f3c14875db44cf8 (patch)
tree0f6e9859da3180281a7cc7d8ab0d74a609ec1853
parent2ed6ffb1d9e4d92ee6b977910e5589be1b9bac85 (diff)
docs: add missing docs on the `transformer` param to RrdQueryDsProxy
-rw-r--r--jarmon/jarmon.js2
1 files changed, 2 insertions, 0 deletions
diff --git a/jarmon/jarmon.js b/jarmon/jarmon.js
index fba8ceb..126671e 100644
--- a/jarmon/jarmon.js
+++ b/jarmon/jarmon.js
@@ -407,6 +407,8 @@ jarmon.RrdQueryRemote.prototype.getDSNames = function() {
* @constructor
* @param rrdQuery {jarmon.RrdQueryRemote} An RrdQueryRemote instance
* @param dsId {(string|number)} identifier of the RRD datasource (string or number)
+ * @param {function} [transformer=function(v){return v}] A callable which
+ * performs a transformation of the values returned from the RRD file.
**/
jarmon.RrdQueryDsProxy = function(rrdQuery, dsId, transformer) {
this.rrdQuery = rrdQuery;