From d3d8998eed2fad3d457ae167a77d8383dd1ce908 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Sat, 15 Jun 2019 07:42:02 +0200 Subject: [PATCH] updated docs, renamed wifiNetworks --- CHANGELOG.md | 3 ++- README.md | 4 ++-- docs/history.html | 5 +++++ docs/wifi.html | 2 +- lib/index.d.ts | 2 +- lib/wifi.js | 4 ++-- package.json | 7 ++++++- 7 files changed, 19 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 495fc8e..a6cd409 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,7 +30,8 @@ For major (breaking) changes - version 3 and 2 see end of page. | Version | Date | Comment | | -------------- | -------------- | -------- | -| 4.11.0 | 2019-06-14 | `wifi()` added available wifi networks | +| 4.11.1 | 2019-06-15 | updated docs | +| 4.11.0 | 2019-06-14 | `wifiNetworks()` added available wifi networks | | 4.10.0 | 2019-06-14 | `graphics()` windows multiple display support | | 4.9.2 | 2019-06-12 | type definitions bug fix | | 4.9.1 | 2019-06-11 | `networkStats()` bug fix windows | diff --git a/README.md b/README.md index 918cec6..8a9c020 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ si.cpu() (last 7 major and minor version releases) -- Version 4.11.0: `wifi()` added available wifi networks +- Version 4.11.0: `wifiNetworks()` added available wifi networks - Version 4.10.0: `graphics()` added windows multiple display support, added display size, connection, ... - Version 4.9.0: `graphics()` added vendor, refresh rate, current resolution - Version 4.8.0: added `vboxInfo()` detailed virtual box info @@ -459,7 +459,7 @@ I also created a nice little command line tool called [mmon][mmon-github-url] ( #### 11. Wifi networks | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments | | --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- | -| si.wifi(cb) | [{...}] | X | | X | X | | array of available wifi networks | +| si.wifiNetworks(cb) | [{...}] | X | | X | X | | array of available wifi networks | | | [0].ssid | X | | X | X | | Wifi network SSID | | | [0].bssid | X | | X | X | | BSSID (mac) | | | [0].mode | X | | | | | mode | diff --git a/docs/history.html b/docs/history.html index d111f94..3b6922a 100644 --- a/docs/history.html +++ b/docs/history.html @@ -83,6 +83,11 @@ + + 4.11.1 + 2019-06-15 + updated docs + 4.11.0 2019-06-14 diff --git a/docs/wifi.html b/docs/wifi.html index dec1959..b956725 100644 --- a/docs/wifi.html +++ b/docs/wifi.html @@ -66,7 +66,7 @@ - si.wifi(cb) + si.wifiNetworks(cb) [{...}] X X diff --git a/lib/index.d.ts b/lib/index.d.ts index eb94b8b..598597b 100644 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -639,7 +639,7 @@ export function networkConnections(cb?: (data: Systeminformation.NetworkConnecti export function inetChecksite(url: string, cb?: (data: Systeminformation.InetChecksiteData) => any): Promise; export function inetLatency(host?: string, cb?: (data: number) => any): Promise; -export function wifi(cb?: (data: Systeminformation.WifiNetworkData[]) => any): Promise; +export function wifiNetworks(cb?: (data: Systeminformation.WifiNetworkData[]) => any): Promise; export function users(cb?: (data: Systeminformation.UserData[]) => any): Promise; diff --git a/lib/wifi.js b/lib/wifi.js index d6a0705..64ca3b5 100644 --- a/lib/wifi.js +++ b/lib/wifi.js @@ -110,7 +110,7 @@ function wifiFrequencyFromChannel(channel) { return frequencies.hasOwnProperty(channel) ? frequencies[channel] : -1; } -function wifi(callback) { +function wifiNetworks(callback) { return new Promise((resolve) => { process.nextTick(() => { @@ -238,4 +238,4 @@ function wifi(callback) { }); } -exports.wifi = wifi; +exports.wifiNetworks = wifiNetworks; diff --git a/package.json b/package.json index 341c0db..ca6d823 100644 --- a/package.json +++ b/package.json @@ -62,7 +62,12 @@ "gpu", "display", "smart", - "disk layout" + "disk layout", + "wifi", + "wifinetworks", + "virtual box", + "virtualbox", + "vm" ], "repository": { "type": "git",