node-system-stats / Exports
• Const
PID: number
= process.pid
src/node-system-stats.ts:75
• Const
cpuModel: string
src/node-system-stats.ts:55
• Const
name: string
= packageJsonFile.name
src/node-system-stats.ts:65
• Const
platform: Platform
= process.platform
src/node-system-stats.ts:70
• Const
totalCores: number
src/node-system-stats.ts:50
• Const
version: string
= packageJsonFile.version
src/node-system-stats.ts:60
▸ avgClockMHz(): number
This function shows the average Clock Frequency from all of the cores.
number
returns a number with the average Clock MHz over all cores
src/node-system-stats.ts:109
▸ clockMHz(coreIndex?
): number
| number
[]
This function returns the speed of all cores or only just the selected core.
Name | Type | Description |
---|---|---|
coreIndex? |
number |
The index of the core. It begins with 0. If not specified, it will return an array with all of the cores |
number
| number
[]
A number of the speed of the core OR a array with all of the cores speeds.
src/node-system-stats.ts:82
▸ showFreeMemory(convertedGB?
): number
This function is used to display the free memory that the system has. It can output in Gigabyte and Megabyte.
Name | Type | Default value | Description |
---|---|---|---|
convertedGB |
boolean |
false |
If the returned value should be in Gigabytes or in MB. If set to true, then it will output the Gigabyte value. |
number
The converted free Memory that is available.
Default
{false} Megabyte format.
src/node-system-stats.ts:166
▸ showMemoryUsage(): MemoryUsageReturn
Shows the formmated Memory Usage information
An object with every converted memory usage type in redable form.
src/node-system-stats.ts:125
▸ showTotalMemory(convertedGB?
): number
This function is used to display the total memory that the system has. It can output in Gigabyte and Megabyte.
Name | Type | Default value | Description |
---|---|---|---|
convertedGB |
boolean |
false |
If the returned value should be in Gigabytes or in MB. If set to true, then it will output the Gigabyte value. |
number
The converted total Memory that is available.
Default
{false} Megabyte format.
src/node-system-stats.ts:150
▸ usagePercent(optsInput?
): Promise
<ICallback
>
This function measures the CPU usage
Name | Type | Description |
---|---|---|
optsInput? |
IOptsInput |
The options input |
Promise
<ICallback
>
returns a resolvable promise
src/node-system-stats.ts:18