ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-24 07:16:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[API] TelemetryRequest

Browse Source
This commit is contained in:
Victor Woeltjen 2016-09-07 10:15:57 -07:00
parent 7279c5d857
commit d56f30c15a
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/api/telemetry/TelemetryAPI.js
View File

@ -73,6 +73,19 @@ define([
* of possible values * of possible values
*/ */
/**
* Describes and bounds requests for telemetry data.
*
* @typedef TelemetryRequest
* @memberof module:openmct.TelemetryAPI~
* @property {string} sort the key of the property to sort by
* @property {*} start the lower bound for values of the sorting property
* @property {*} end the upper bound for values of the sorting property
* @property {string[]} strategies symbolic identifiers for strategies
* (such as `minmax`) which may be recognized by providers;
* these will be tried in order until an appropriate provider
* is found
*/
/** /**
* An interface for retrieving telemetry data associated with a domain * An interface for retrieving telemetry data associated with a domain