@iobroker/types 7.0.4-alpha.2-20241128-664d3c562 → 7.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/build/shared.d.ts +41 -5
  2. package/package.json +2 -2
package/build/shared.d.ts CHANGED
@@ -290,20 +290,56 @@ declare global {
290
290
 
291
291
  interface GetHistoryOptions {
292
292
  instance?: string;
293
+ /** Start time in ms */
293
294
  start?: number;
295
+ /** End time in ms. If not defined, it is "now" */
294
296
  end?: number;
297
+ /** Step in ms of intervals. Used in aggregate (max, min, average, total, ...) */
295
298
  step?: number;
299
+ /** number of values if aggregate is 'onchange' or number of intervals if other aggregate method. Count will be ignored if step is set, else default is 500 if not set */
296
300
  count?: number;
301
+ /** if `from` field should be included in answer */
297
302
  from?: boolean;
303
+ /** if `ack` field should be included in answer */
298
304
  ack?: boolean;
305
+ /** if `q` field should be included in answer */
299
306
  q?: boolean;
300
- addID?: boolean;
307
+ /** if `id` field should be included in answer */
308
+ addId?: boolean;
309
+ /** do not return more entries than limit */
301
310
  limit?: number;
302
- ignoreNull?: boolean;
303
- sessionId?: any;
304
- aggregate?: 'minmax' | 'min' | 'max' | 'average' | 'total' | 'count' | 'none';
311
+ /** round result to number of digits after decimal point */
312
+ round?: number;
313
+ /** if null values should be included (false), replaced by last not null value (true) or replaced with 0 (0) */
314
+ ignoreNull?: boolean | 0;
315
+ /** This number will be returned in answer, so the client can assign the request for it */
316
+ sessionId?: number;
317
+ /** aggregate method (Default: 'average') */
318
+ aggregate?:
319
+ | 'onchange'
320
+ | 'minmax'
321
+ | 'min'
322
+ | 'max'
323
+ | 'average'
324
+ | 'total'
325
+ | 'count'
326
+ | 'none'
327
+ | 'percentile'
328
+ | 'quantile'
329
+ | 'integral'
330
+ | 'integralTotal';
305
331
  /** Returned data is normally sorted ascending by date, this option lets you return the newest instead of the oldest values if the number of returned points is limited */
306
332
  returnNewestEntries?: boolean;
333
+ /** By default, the additional border values are returned to optimize charting. Set this option to true if this is not wanted (e.g. for script data processing) */
334
+ removeBorderValues?: boolean;
335
+ /** when using aggregate method `percentile` defines the percentile level (0..100)(defaults to 50) */
336
+ percentile?: number;
337
+ /** when using aggregate method `quantile` defines the quantile level (0..1)(defaults to 0.5) */
338
+ quantile?: number;
339
+ /** when using aggregate method `integral` defines the unit in seconds (defaults to 60s). e.g. to get integral in hours for Wh or such, set to 3600. */
340
+ integralUnit?: number;
341
+ /** when using aggregate method `integral` defines the interpolation method (defaults to `none`). */
342
+ integralInterpolation?: 'none' | 'linear';
307
343
  }
308
344
 
309
345
  interface DelObjectOptions {
@@ -442,7 +478,7 @@ declare global {
442
478
  err: Error | null,
443
479
  result?: GetHistoryResult,
444
480
  step?: number,
445
- sessionId?: string,
481
+ sessionId?: number,
446
482
  ) => void;
447
483
 
448
484
  /** Contains the return values of readDir */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iobroker/types",
3
- "version": "7.0.4-alpha.2-20241128-664d3c562",
3
+ "version": "7.0.4",
4
4
  "engines": {
5
5
  "node": ">=12.0.0"
6
6
  },
@@ -41,5 +41,5 @@
41
41
  ]
42
42
  }
43
43
  },
44
- "gitHead": "28ecc2db09db36d9b5bd9ddb4dca5511735d5711"
44
+ "gitHead": "23152c75d56784bae0d94cd07c35135ed5556bf4"
45
45
  }