mike/systeminformation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Sebastian Hildebrandt 2020-08-24 15:57:38 +02:00
parent 9885a9c655
commit 63aeb80b7b
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -30,7 +30,7 @@
[![Sponsoring][sponsor-badge]][sponsor-url]
[![MIT license][license-img]][license-url]
This is amazing. Started as a small project just for myself, it now has > 9,000 lines of code, > 300 versions published, > 1 mio downloads per month, > 10 mio downloads overall. Thank you to all who contributed to this project!
This is amazing. Started as a small project just for myself, it now has > 9,000 lines of code, > 300 versions published, > 1 mio downloads per month, > 15 mio downloads overall. Thank you to all who contributed to this project!
## New Version 4.0

10
docs/statsfunctions.html
View File

@ -66,8 +66,8 @@ setInterval(function() {
}, 1000)</code></pre>
<p>Beginning with the second call, you get network transfer values per second.</p>
<h2>Observe System Parameters</h2>
<p>systeminformation now allows you to easily observe system poarameters: First you define a result object of system parameters you want to abserve (see also secription of the <a href="general.html"><span class="code">si.get()</span> function here</a>):</p>
<p>Then you just call an <span class="code">si.observe()</span> function with three parameters: your result object, the polling interval (in miliseconds) and a callback function. Systeminformation will now observe the result object. Every time the result changes, this callback function is called. Your callback function also gets the current value of all observed system parameters.</p>
<p>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 <a href="general.html"><span class="code">si.get()</span> function here</a>):</p>
<p>Then you just call an <span class="code">si.observe()</span> 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.</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
@ -89,7 +89,7 @@ setInterval(function() {
<td>X</td>
<td>X</td>
<td>X</td>
<td>Observe the defined value object<br>call callback on changes:</td>
<td>Observe the defined value object,<br>call callback on changes:</td>
</tr>
<tr class="example">
<td></td>
@ -116,7 +116,7 @@ setTimeout(() => {
</tr>
</tbody>
</table>
<p>The key names of the <span class="code">valueObject</span> must be exactly the same as the representing function within systeminformation.</p>
<p>The key names of the <span class="code">valueObject</span> must be exactly the same as the representing function in systeminformation.</p>
</div>
</div>
@ -164,4 +164,4 @@ setTimeout(() => {
</script>
</body>
</html>
</html>