Skip to content

Commit 378698d

Browse files
authoredMar 13, 2018
Merge pull request #38 from signalfx/immediate
update readme to document immediate parameter
2 parents 6df3989 + 2361d87 commit 378698d

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed
 

‎README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,9 @@ var handle = client.execute({
216216
program: "data('cpu.utilization').mean().publish()",
217217
start: Date.now() - 60000,
218218
stop: Date.now() + 60000,
219-
resolution: 10000});
220-
219+
resolution: 10000,
220+
immediate: false});
221+
221222
handle.stream(function(err, data) { console.log(data); });
222223
```
223224

@@ -228,11 +229,12 @@ Please note that a token created via the REST API is necessary to use this API.
228229
Parameters to the execute method are as follows :
229230

230231
+ **program** (string) - Required field. The signalflow to be run.
231-
+ **start** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -1h. Defaults to now.
232-
+ **end** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -30m. Defaults to infinity.
233-
+ **resolution** (int) - The interval across which to calculate, in 1000 millisecond intervals. Defaults to 1000.
232+
+ **start** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -1h. Defaults to now.
233+
+ **stop** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -30m. Defaults to infinity.
234+
+ **resolution** (int) - The interval across which to calculate, in 1000 millisecond intervals. Defaults to 1000.
234235
+ **maxDelay** (int) - The maximum time to wait for a datapoint to arrive, in 10000 millisecond intervals. Defaults to dynamic.
235236
+ **bigNumber** (boolean) - True if returned values require precision beyond MAX_SAFE_INTEGER. Returns all values in data messages as bignumber objects as per https://www.npmjs.com/package/bignumber.js Defaults to false.
237+
+ **immediate** (boolean) - Whether to adjust the stop timestamp so that the computation doesn't wait for future data to be available.
236238

237239
#### Computation Objects
238240

0 commit comments

Comments
 (0)
Please sign in to comment.