updated docs - examples
This commit is contained in:
Sebastian Hildebrandt
parent
04fdf5112e
commit
58721f8a88
@ -225,7 +225,7 @@
|
||||
<td></td>
|
||||
<td>battery serial</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
|
||||
@ -285,6 +285,35 @@
|
||||
<td></td>
|
||||
<td>L3 size</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpu().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Intel®',
|
||||
brand: 'Core™ i9-9900',
|
||||
vendor: 'GenuineIntel',
|
||||
family: '6',
|
||||
model: '158',
|
||||
stepping: '13',
|
||||
revision: '',
|
||||
voltage: '',
|
||||
speed: '3.10',
|
||||
speedmin: '0.80',
|
||||
speedmax: '5.00',
|
||||
governor: 'powersave',
|
||||
cores: 16,
|
||||
physicalCores: 8,
|
||||
processors: 1,
|
||||
socket: 'LGA1151',
|
||||
cache: { l1d: 262144, l1i: 262144, l2: 2, l3: 16 },
|
||||
flags: 'fpu vme de pse ...'
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.cpuFlags(cb)</td>
|
||||
<td>: string</td>
|
||||
@ -295,6 +324,16 @@
|
||||
<td></td>
|
||||
<td>CPU flags</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuFlags().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.cpuCache(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -345,6 +384,16 @@
|
||||
<td></td>
|
||||
<td>L3 size</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuCache().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ l1d: 262144, l1i: 262144, l2: 2, l3: 16 }
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.cpuCurrentspeed(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -395,6 +444,26 @@
|
||||
<td>X</td>
|
||||
<td>CPU speed per core (array)</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuCurrentspeed().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
min: 0.86,
|
||||
max: 1.77,
|
||||
avg: 1.49,
|
||||
cores: [
|
||||
1.59, 1.71, 1.62, 1.57,
|
||||
1.66, 1.77, 1.74, 1.75,
|
||||
1.49, 1.51, 1.52, 1.59,
|
||||
1.56, 1.03, 0.86, 0.86
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.cpuTemperature(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -435,6 +504,16 @@
|
||||
<td></td>
|
||||
<td>max temperature</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuCurrentspeed().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ main: 42, cores: [], max: 42 }
|
||||
</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Known issues</h2>
|
||||
|
||||
@ -195,6 +195,29 @@
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.mem().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
total: 67092135936,
|
||||
free: 65769291776,
|
||||
used: 1322844160,
|
||||
active: 1032495104,
|
||||
available: 66059640832,
|
||||
buffers: 63213568,
|
||||
cached: 800124928,
|
||||
slab: 268804096,
|
||||
buffcache: 1132142592,
|
||||
swaptotal: 8589930496,
|
||||
swapused: 0,
|
||||
swapfree: 8589930496
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.memLayout(cb)</td>
|
||||
<td>[{...}]</td>
|
||||
@ -315,6 +338,43 @@
|
||||
<td></td>
|
||||
<td>voltage max</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.memLayout().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
size: 34359738368,
|
||||
bank: 'BANK 0',
|
||||
type: 'DDR4',
|
||||
clockSpeed: 2667,
|
||||
formFactor: 'SODIMM',
|
||||
manufacturer: '029E',
|
||||
partNum: 'CMSX64.....',
|
||||
serialNum: '00000000',
|
||||
voltageConfigured: 1.2,
|
||||
voltageMin: 1.2,
|
||||
voltageMax: 1.2
|
||||
},
|
||||
{
|
||||
size: 34359738368,
|
||||
bank: 'BANK 2',
|
||||
type: 'DDR4',
|
||||
clockSpeed: 2667,
|
||||
formFactor: 'SODIMM',
|
||||
manufacturer: '029E',
|
||||
partNum: 'CMSX64.....',
|
||||
serialNum: '00000000',
|
||||
voltageConfigured: 1.2,
|
||||
voltageMin: 1.2,
|
||||
voltageMax: 1.2
|
||||
}
|
||||
]
|
||||
</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
@ -586,10 +586,27 @@ pre {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.example {
|
||||
.example td:first-child {
|
||||
background-color: #fff !important;
|
||||
}
|
||||
|
||||
.example td:last-child {
|
||||
background-color: #f8faff !important;
|
||||
}
|
||||
|
||||
.example h5 {
|
||||
padding-top: 5px;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
.example pre {
|
||||
background-color: unset;
|
||||
}
|
||||
|
||||
.example pre .js {
|
||||
background-color: #f0f0f4;
|
||||
}
|
||||
|
||||
footer {
|
||||
background-color: #eee;
|
||||
margin-top: 30px;
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -407,7 +407,23 @@ pre {
|
||||
text-align: left;
|
||||
}
|
||||
.example {
|
||||
background-color: unset;
|
||||
td:first-child {
|
||||
background-color: #fff !important;
|
||||
}
|
||||
td:last-child {
|
||||
background-color: #f8faff !important;
|
||||
}
|
||||
h5 {
|
||||
padding-top: 5px;
|
||||
padding-left: 10px;
|
||||
}
|
||||
pre {
|
||||
background-color: unset;
|
||||
.js {
|
||||
background-color: #f0f0f4;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
footer {
|
||||
background-color: #eee;
|
||||
|
||||
@ -135,6 +135,23 @@
|
||||
<td></td>
|
||||
<td>SKU number</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.system().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Apple Inc.',
|
||||
model: 'MacBookPro13,2',
|
||||
version: '1.0',
|
||||
serial: 'C01xxxxxxxx',
|
||||
uuid: 'F87654-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
||||
sku: 'Mac-99878xxxx...'
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.bios(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -185,6 +202,20 @@
|
||||
<td></td>
|
||||
<td>revision</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.bios().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
vendor: 'American Megatrends Inc.',
|
||||
version: 'P4.20',
|
||||
releaseDate: '2019-09-05',
|
||||
revision: '5.13'
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.baseboard(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -245,6 +276,21 @@
|
||||
<td></td>
|
||||
<td>asset tag</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.baseboard().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'ASRock',
|
||||
model: 'H310M-STX',
|
||||
version: '',
|
||||
serial: 'C80-xxxxxxxxxxx',
|
||||
assetTag: ''
|
||||
} </pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.chassis(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -325,6 +371,24 @@
|
||||
<td></td>
|
||||
<td>SKU number</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.chassis().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Apple Inc.',
|
||||
model: 'MacBookPro13,2',
|
||||
type: '',
|
||||
version: '1.0',
|
||||
serial: 'C01xxxxxxxx',
|
||||
assetTag: 'Mac-99878xxxx...',
|
||||
sku: ''
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user