index.js

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