TobiasH/node-wifi-scanner
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change jsdoc; Fix lang

Browse Source
This commit is contained in:
Tobias Hopp 2024-03-27 23:32:04 +01:00
parent debd06f258
commit a5ad7ea8a5
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
index.js
View File

@ -1,15 +1,16 @@
/** /**
* @typedef {Object} WifiNetwork * @typedef {Object} WifiNetwork
* @property {string} ssid - SSID des WLAN-Netzwerks * @property {string} ssid - SSID of the wifi
* @property {string} mac - MAC-Adresse des WLAN-Netzwerks * @property {string} mac - MAC-Address of the wifi
* @property {number} channel - Kanal des WLAN-Netzwerks * @property {number} channel - Channel of the wifi
* @property {number} rssi - Signalstärke des WLAN-Netzwerks (RSSI) * @property {number} rssi - Signalstrength of Wifi-Network (RSSI)
* @property {boolean} encrypted - Encrypted
*/ */
/** /**
* node-wifi-scanner * node-wifi-scanner
* Created by kc on 04.04.16. * Created by kc on 04.04.16. - Forked and updated by Tobias Hopp 27.03.2024
*/ */
const exec = require('child_process').exec; const exec = require('child_process').exec;
@ -81,7 +82,7 @@ function scanNetworks(callback, useSudo) {
module.exports = { module.exports = {
/** /**
* Funktion zum Scannen von WLAN-Netzwerken * Scan for wifi networks
* @param {boolean} useSudo? - Defaults to false | Should sudo be used to get the output? * @param {boolean} useSudo? - Defaults to false | Should sudo be used to get the output?
* @return {Promise<WifiNetwork[]|null>} WiFinetwork Array or null * @return {Promise<WifiNetwork[]|null>} WiFinetwork Array or null
* @rejects Returns error on reject * @rejects Returns error on reject