specs_window
Version:
It is a NodeJS module to get hardware informacions.
336 lines (253 loc) • 6.91 kB
Markdown
# Specs for Windows 🪟:
## Installation:
It is a NodeJS module to get hardware and OS informacions.
````
npm install specs_window
````
## Project info:
- author: Riseghost 👻
- languague: C/C++
- platform support: Windows 🪟
- github: https://github.com/RiseGhost/specs_window
- npm profil: https://www.npmjs.com/~riseghost
## Features:
- Get CPU Thread number;
- Get CPU Cores number;
- Get PC Name (Host Name);
- Get CPU Architecture ⚠️;
- Get Total RAM Memory install;
- Get Free RAM Memory;
- Get Available Drives (Units: C:\\, G:\\, F:\\, ...);
- Get Size Drives;
- Get Processes;
- Kill Processes;
- Get Cursor/Mouse position;
- Move Cursor/Mouse;
- Get Screen Size;
- Get Files by Path
### Get CPU Threads number 🧠:
````JS
const specs = require('specs_window')
console.log(specs.getProcessorsNumber())
````
### Get CPU Cores number:
````JS
const specs = require('specs_window')
console.log(specs.getProcessorsCore())
````
### Get PC Name (Host Name) 🖥️:
````JS
const specs = require('specs_window')
console.log(specs.getPCName())
````
### Get CPU Architecture ⚠️:
This func is under maintenance.
````JS
const specs = require('specs_window')
console.log(specs.getProcessorArchitecture())
````
### Get Total RAM Memory install 🗄️:
There are two func to get the Total Memory:
- getTotalMemory()
- getTotalMemoryGB()
##### getTotalMemory():
````JS
const specs = require('specs_window')
console.log(specs.getTotalMemory())
````
The fist func, getTotalMemory, return the following object:
````JS
{
Bytes: 17041244160,
KiloBytes: 16641840,
MegaBytes: 16251.796875,
GigaBytes: 15.870895385742188
}
````
##### getTotalMemoryGB():
````JS
const specs = require('specs_window')
console.log(specs.getTotalMemoryGB())
````
The second func, getTotalMemoryGB, return just GB:
````JS
15.870895385742188
````
### Get Free RAM Memory 🗄️🆓:
There are two func to get the Free Memory:
- getFreeMemory()
- getFreeMemoryGB()
##### getFreeMemory():
````JS
const specs = require('specs_window')
console.log(specs.getFreeMemory())
````
The first func, getFreeMemory, return the following object:
````JS
{
Bytes: 3957870592,
KiloBytes: 3865108,
MegaBytes: 3774.51953125,
GigaBytes: 3.686054229736328
}
````
#### getFreeMemoryGB():
````JS
const specs = require('specs_window')
console.log(specs.getFreeMemoryGB())
````
The second func, getFreeMemoryGB, return just GB:
````JS
3.686054229736328
````
### Get Available Drive ☑️💿:
This func return __all__ available drive path, include:
- Internal drives:
- Hard disk;
- SSD
- External drives:
- pendrives;
- external disk (HD or SSD)
- ...
Does not work with smarphones, tables, nintendo switch, ...
````JS
const specs = require('specs_window')
console.log(specs.getAvailableDrives())
````
````JS
[ 'C:\\', 'G:\\' ]
````
### Get Size Drives 🗄️💿:
This func return the Free Memory and Full Memory of Path Drive.
Path Dive is for exemple:
- C:\\\\
- G:\\\\
- F:\\\\
- ....
This func can you recive a individual Path Drive or a array with many Path Drive.
````JS
const specs = require('specs_window')
const Drives = specs.getAvailableDrives()
console.log(specs.getSizeDrives(Drives))
````
````JS
[
{ FreeMemory: 9531, FullMemory: 425668.99609375 },
{ FreeMemory: -1, FullMemory: -1 }
]
````
If the func can´t read a Memory of Drive return -1.
### Get Processes 🌀:
This func return a array with __all__ process running in machine.
````JS
const specs = require('specs_window')
specs.getProcesses().then((res) => {
res.forEach(element => {console.log(element)});
})
//or:
specs.getProcesses().then((res) => {console.log(res)})
````
````JS
{
PID: 23060,
Name: 'Code.exe',
MemoryCommit: 26976,
MemoryWorkingSet: 91436
}
{
PID: 46872,
Name: 'firefox.exe',
MemoryCommit: 171060,
MemoryWorkingSet: 212420
}
{
PID: 85324,
Name: 'firefox.exe',
MemoryCommit: 26820,
MemoryWorkingSet: 29392
}
````
If doesn´t get the Processe Memory, return -1.
### Kill Processes ☠️🌀:
The func KillProcesse takes an int as an argument to represent the processe id (PID).
In this exemple, I kill Micrsoft Edge processe.
````JS
const specs = require('specs_window')
specs.getProcesses().then((res) => {
res.forEach(Processe => {
if(Processe.Name == "msedge.exe")
specs.KillProcesse(Processe.PID).then((kill) => {console.log(kill)})
});
})
````
### Get Cursor/Mouse position 🐁🗺️:
Return the mouse position in the screen not in the window.
````JS
const specs = require('specs_window')
console.log(specs.getMousePos())
````
````JS
{ X: 1642, Y: 847 }
````
### Move Cursor/Mouse 🐁➡️:
Yes, you can move de Cursor/Mouse.
````JS
const specs = require('specs_window')
specs.MoveMouse(500,900)
````
### Get Screen Size 📺📐:
Return the Screen Size in pixeis.
````JS
const specs = require('specs_window')
console.log(specs.getScreenSize())
````
````JS
{ width: 1920, height: 1080 }
````
### Get Files by Path 🗂️🛣️:
This func recive with argument a path and return a array with all files and diretorys in path. You can give a path to a pendrive or another storage Unit.
````JS
const specs = require('specs_window')
specs.getFilesPath("C:\\").then((res) => {console.log(res)})
````
Only for a file can you get the file size in KiloBytes.
````JS
[
{ Name: 'BIOS', Type: 'DIR' },
{ Name: 'Config.Msi', Type: 'DIR' },
{ Name: 'discord-avatar.jpg', Type: 'File', KB: 354805 },
{ Name: 'Documents and Settings', Type: 'DIR' },
{ Name: 'Drivers', Type: 'DIR' },
{ Name: 'flutter', Type: 'DIR' },
{ Name: 'hiberfil.sys', Type: 'File', KB: 6816497664 },
{ Name: 'Intel', Type: 'DIR' },
{ Name: 'Java', Type: 'DIR' },
{ Name: 'mingw64', Type: 'DIR' },
{ Name: 'NiceHash', Type: 'DIR' },
{ Name: 'OneDriveTemp', Type: 'DIR' },
{ Name: 'pagefile.sys', Type: 'File', KB: 19811954688 },
{ Name: 'PATH_PROGRAM', Type: 'DIR' },
{ Name: 'Pearlabyss', Type: 'DIR' },
{ Name: 'PerfLogs', Type: 'DIR' },
{ Name: 'php', Type: 'DIR' },
{ Name: 'Program Files', Type: 'DIR' },
{ Name: 'Program Files (x86)', Type: 'DIR' },
{ Name: 'Programas', Type: 'DIR' },
{ Name: 'ProgramData', Type: 'DIR' },
{ Name: 'Python310', Type: 'DIR' },
{ Name: 'Recovery', Type: 'DIR' },
{ Name: 'Registadora.jar', Type: 'File', KB: 4578 },
{ Name: 'Riot Games', Type: 'DIR' },
{ Name: 'SQL2019', Type: 'DIR' },
{ Name: 'swapfile.sys', Type: 'File', KB: 16777216 },
{ Name: 'System Volume Information', Type: 'DIR' },
{ Name: 'temp', Type: 'DIR' },
{ Name: 'tools', Type: 'DIR' },
{ Name: 'UserBenchmark', Type: 'DIR' },
{ Name: 'Users', Type: 'DIR' },
{ Name: 'vcpkg', Type: 'DIR' },
{ Name: 'WhatsappKeys', Type: 'DIR' },
{ Name: 'Windows', Type: 'DIR' },
{ Name: 'XboxGames', Type: 'DIR' }
]
````