systeminformation

Stats Functions

## Getting correct stats values

In fsStats(), disksIO(), currentLoad() and networkStats() the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of the function. It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

The first time you are calling one of this functions, you will get -1 for transfer rates. The second time, you should then get statistics based on the time between the two calls ...

So basically, if you e.g. need a values for network stats every second, your code should look like this:

    const si = require('systeminformation');

    setInterval(function() {
        si.networkStats().then(data => {
            console.log(data);
        })
    }, 1000)

Beginning with the second call, you get network transfer values per second.

## Observe System Parameters

systeminformation now allows you to easily observe system parameters: First you define a result object of system parameters you want to observe (see also decription of the si.get() function here):

Then you just call an si.observe() function with three parameters: your result object, the polling interval (in milliseconds) and a callback function. systeminformation will now observe the result object. Every time the result changes, your callback function is called. This callback function also gets the current value the observed system parameters object.

Function | Result object | Linux | BSD | Mac | Win | Sun | Comments
--- | --- | --- | --- | --- | --- | --- | ---
si.observe(valueObject,interval,cb) | - | X | X | X | X | X | Observe the defined value object, call callback on changes:
| ##### Example
    const si = require('systeminformation');

    // define all values, you want to get back
    valueObject = {
      battery: 'acconnected'
    }

    function usersCallback(data) {
      console.log('Power usage now: ' + (data.battery.acconnected ? 'AC' : 'battery'));
    }

    // now define the observer function
    let observer = si.observe(valueObject, 1000, usersCallback);

    // In this example we stop our observer function after 30 seconds
    setTimeout(() => {
      clearInterval(observer)
    }, 30000);

The key names of the valueObject must be exactly the same as the representing function in systeminformation.