Skip to content

Commit

Permalink
Reference original prototype (#1)
Browse files Browse the repository at this point in the history
Add a reference to the original code.
  • Loading branch information
phoddie authored and ScreamZ committed Nov 27, 2024
1 parent 416a193 commit 5f09335
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type WiFiMessage =
| "station_disconnect";

/**
* WiFiConnectionManager is designed to be used in place of the "wifi" module in project, that need a continuously available connection to a Wi-Fi access point.
* WiFiConnectionManager is designed to be used in place of the "wifi" module in projects that need a continuously available connection to a Wi-Fi access point.
*
* - If no connection available at start, retries until one is.
* - Automatically attempts to reconnect when connection dropped.
Expand Down Expand Up @@ -47,6 +47,9 @@ type WiFiMessage =
* }
* );
* ```
*
* This code is based on the Wi-Fi Connection example in the Moddable SDK:
* https://github.com/Moddable-OpenSource/moddable/blob/public/examples/network/wifi/wificonnection/wificonnection.js
*/
export class WiFiConnectionManager extends WiFi {
private reconnectTimer?: Timer;
Expand Down

0 comments on commit 5f09335

Please sign in to comment.