Module: inputValidators

Methods

---

<static> validateCachedGaugeOptions(name, callback, dimensions, publishingIntervalInSeconds)

Validates @{link Gauge} options.

Parameters:

Name	Type	Description
name	string	The metric name
callback	function	The callback for the CachedGauge
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 31

---

<static> validateCommonMetricParameters(name, dimensions, publishingIntervalInSeconds)

Validates the options that are common amoung all create metric methods

Parameters:

Name	Type	Description
name	string	The metric name
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 100

---

<static> validateCounterOptions(name, dimensions, publishingIntervalInSeconds)

Validates the create counter Options.

Parameters:

Name	Type	Description
name	string	The metric name
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 54

---

<static> validateGaugeOptions(name, callback, dimensions, publishingIntervalInSeconds)

Validates @{link Gauge} options.

Parameters:

Name	Type	Description
name	string	The metric name
callback	function	The callback for the Gauge
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 18

---

<static> validateHistogramOptions(name, dimensions, publishingIntervalInSeconds)

Validates the create histogram Options.

Parameters:

Name	Type	Description
name	string	The metric name
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 43

---

<static> validateMetricName(name)

Validates the metric name.

Parameters:

Name	Type	Description
name		The metric name.

Source:

• measured-reporting/lib/validators/inputValidators.js, line 111

---

<static> validateNumberReturningCallback(callback)

Validates the provided callback.

Parameters:

Name	Type	Description
callback		The provided callback for a gauge.

Source:

• measured-reporting/lib/validators/inputValidators.js, line 132

---

<static> validateOptionalDimensions(dimensionsOptional)

Validates a set of optional dimensions

Parameters:

Name	Type	Description
dimensionsOptional

Source:

• measured-reporting/lib/validators/inputValidators.js, line 148

---

<static> validateOptionalLogger(loggerOptional)

Validates that an optional logger instance at least has the methods we expect.

Parameters:

Name	Type	Description
loggerOptional

Source:

• measured-reporting/lib/validators/inputValidators.js, line 172

---

<static> validateOptionalPublishingInterval(publishingIntervalInSecondsOptional)

Validates the optional publishing interval.

Parameters:

Name	Type	Description
publishingIntervalInSecondsOptional		The optional publishing interval.

Source:

• measured-reporting/lib/validators/inputValidators.js, line 194

---

<static> validateRegisterOptions(name, metric, dimensions, publishingIntervalInSeconds)

Validates the create timer Options.

Parameters:

Name	Type	Description
name	string	The metric name
metric	Metric	The metric instance
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 77

---

<static> validateReporterInstance(reporter)

Validates that a valid Reporter object has been supplied

Parameters:

Name	Type	Description
reporter	Reporter

Source:

• measured-reporting/lib/validators/inputValidators.js, line 224

---

<static> validateReporterParameters(options)

Validates optional params for a Reporter

Parameters:

Name	Type	Description
options	ReporterOptions	The optional params

Source:

• measured-reporting/lib/validators/inputValidators.js, line 207

---

<static> validateSelfReportingMetricsRegistryParameters(reporters [, options])

Validates the input parameters for a SelfReportingMetricsRegistry

Parameters:

Name	Type	Argument	Description
reporters	Array.<Reporter>
options	SelfReportingMetricsRegistryOptions	<optional>

Source:

• measured-reporting/lib/validators/inputValidators.js, line 245

---

<static> validateSettableGaugeOptions(name, dimensions, publishingIntervalInSeconds)

Validates the create settable gauge Options.

Parameters:

Name	Type	Description
name	string	The metric name
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 89

---

<static> validateTimerOptions(name, dimensions, publishingIntervalInSeconds)

Validates the create timer Options.

Parameters:

Name	Type	Description
name	string	The metric name
dimensions	Dimensions	The optional custom dimensions
publishingIntervalInSeconds	number	the optional publishing interval

Source:

• measured-reporting/lib/validators/inputValidators.js, line 65

---

<inner> validateMetric(metric)

Validates that a metric implements the metric interface.

Parameters:

Name	Type	Description
metric	Metric	The object that is supposed to be a metric.

Source:

• measured-reporting/lib/validators/inputValidators.js, line 118