From 5f093359ba841c24574b72113eb0a9189904a507 Mon Sep 17 00:00:00 2001 From: Peter Hoddie Date: Wed, 27 Nov 2024 02:34:12 -0800 Subject: [PATCH] Reference original prototype (#1) Add a reference to the original code. --- src/index.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/index.ts b/src/index.ts index 095f9bf..a7c79e1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -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. @@ -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;