Skip to content

Commit dd3161f

Browse files
electricessenceelectricessence
committed
Update documentation and add license file
- Updated the `node.html` documentation to reflect the latest changes in the NodeWebSocketConnector module. - Modified the `index.WebSocketMessage.html` to update the source link for WebSocketMessage. - Added a new LICENSE file with the MIT License. - Created a new `modules.html` file to provide an overview of the modules in the @tsdotnet/websocket-connector package.
1 parent dbf9d8d commit dd3161f

19 files changed

+259
-143
lines changed

‎docs/assets/highlight.css‎

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
:root {
2-
--light-hl-0: #0000FF;
3-
--dark-hl-0: #569CD6;
2+
--light-hl-0: #795E26;
3+
--dark-hl-0: #DCDCAA;
44
--light-hl-1: #000000;
55
--dark-hl-1: #D4D4D4;
6-
--light-hl-2: #0070C1;
7-
--dark-hl-2: #4FC1FF;
8-
--light-hl-3: #795E26;
9-
--dark-hl-3: #DCDCAA;
10-
--light-hl-4: #A31515;
11-
--dark-hl-4: #CE9178;
12-
--light-hl-5: #001080;
13-
--dark-hl-5: #9CDCFE;
14-
--light-hl-6: #098658;
15-
--dark-hl-6: #B5CEA8;
16-
--light-hl-7: #AF00DB;
17-
--dark-hl-7: #C586C0;
18-
--light-hl-8: #267F99;
19-
--dark-hl-8: #4EC9B0;
20-
--light-hl-9: #008000;
21-
--dark-hl-9: #6A9955;
6+
--light-hl-2: #A31515;
7+
--dark-hl-2: #CE9178;
8+
--light-hl-3: #AF00DB;
9+
--dark-hl-3: #C586C0;
10+
--light-hl-4: #001080;
11+
--dark-hl-4: #9CDCFE;
12+
--light-hl-5: #0000FF;
13+
--dark-hl-5: #569CD6;
14+
--light-hl-6: #0070C1;
15+
--dark-hl-6: #4FC1FF;
16+
--light-hl-7: #008000;
17+
--dark-hl-7: #6A9955;
18+
--light-hl-8: #098658;
19+
--dark-hl-8: #B5CEA8;
20+
--light-hl-9: #000000FF;
21+
--dark-hl-9: #D4D4D4;
22+
--light-hl-10: #267F99;
23+
--dark-hl-10: #4EC9B0;
2224
--light-code-background: #FFFFFF;
2325
--dark-code-background: #1E1E1E;
2426
}
@@ -34,6 +36,7 @@
3436
--hl-7: var(--light-hl-7);
3537
--hl-8: var(--light-hl-8);
3638
--hl-9: var(--light-hl-9);
39+
--hl-10: var(--light-hl-10);
3740
--code-background: var(--light-code-background);
3841
} }
3942

@@ -48,6 +51,7 @@
4851
--hl-7: var(--dark-hl-7);
4952
--hl-8: var(--dark-hl-8);
5053
--hl-9: var(--dark-hl-9);
54+
--hl-10: var(--dark-hl-10);
5155
--code-background: var(--dark-code-background);
5256
} }
5357

@@ -62,6 +66,7 @@
6266
--hl-7: var(--light-hl-7);
6367
--hl-8: var(--light-hl-8);
6468
--hl-9: var(--light-hl-9);
69+
--hl-10: var(--light-hl-10);
6570
--code-background: var(--light-code-background);
6671
}
6772

@@ -76,6 +81,7 @@
7681
--hl-7: var(--dark-hl-7);
7782
--hl-8: var(--dark-hl-8);
7883
--hl-9: var(--dark-hl-9);
84+
--hl-10: var(--dark-hl-10);
7985
--code-background: var(--dark-code-background);
8086
}
8187

@@ -89,4 +95,5 @@
8995
.hl-7 { color: var(--hl-7); }
9096
.hl-8 { color: var(--hl-8); }
9197
.hl-9 { color: var(--hl-9); }
98+
.hl-10 { color: var(--hl-10); }
9299
pre, code { background: var(--code-background); }

‎docs/classes/browser.BrowserWebSocketConnector.html‎

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/classes/index.WebSocketConnectorBase.html‎

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/classes/mock.MockWebSocket.html‎

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

‎docs/classes/mock.MockWebSocketConnector.html‎

Lines changed: 29 additions & 29 deletions
Large diffs are not rendered by default.

‎docs/classes/node.NodeWebSocketConnector.html‎

Lines changed: 17 additions & 17 deletions
Large diffs are not rendered by default.

‎docs/enums/index.WebSocketState.html‎

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

‎docs/hierarchy.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@tsdotnet/websocket-connector - v1.0.0</title><meta name="description" content="Documentation for @tsdotnet/websocket-connector"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@tsdotnet/websocket-connector - v1.0.0</a><div id="tsd-toolbar-links"><a href="https://github.com/tsdotnet/websocket-connector">GitHub</a><a href="https://www.npmjs.com/package/@tsdotnet/websocket-connector">npm</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@tsdotnet/websocket-connector - v1.0.0</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="19" id="index.WebSocketConnector"><a href="interfaces/index.WebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WebSocketConnector</a><ul><li data-refl="36" id="index.WebSocketConnectorBase"><a href="classes/index.WebSocketConnectorBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WebSocketConnectorBase</a><ul><li data-refl="96" id="browser.BrowserWebSocketConnector"><a href="classes/browser.BrowserWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>BrowserWebSocketConnector</a></li><li data-refl="141" id="node.NodeWebSocketConnector"><a href="classes/node.NodeWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>NodeWebSocketConnector</a></li><li data-refl="223" id="mock.MockWebSocketConnector"><a href="classes/mock.MockWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>MockWebSocketConnector</a></li></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/tsdotnet/websocket-connector" class="tsd-nav-link">GitHub</a><a href="https://www.npmjs.com/package/@tsdotnet/websocket-connector" class="tsd-nav-link">npm</a></nav><nav class="tsd-navigation"><a href="index.html">@tsdotnet/websocket-connector - v1.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@tsdotnet/websocket-connector - v1.0.0</title><meta name="description" content="Documentation for @tsdotnet/websocket-connector"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@tsdotnet/websocket-connector - v1.0.0</a><div id="tsd-toolbar-links"><a href="https://github.com/tsdotnet/websocket-connector">GitHub</a><a href="https://www.npmjs.com/package/@tsdotnet/websocket-connector">npm</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@tsdotnet/websocket-connector - v1.0.0</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="19" id="index.WebSocketConnector"><a href="interfaces/index.WebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WebSocketConnector</a><ul><li data-refl="36" id="index.WebSocketConnectorBase"><a href="classes/index.WebSocketConnectorBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WebSocketConnectorBase</a><ul><li data-refl="96" id="browser.BrowserWebSocketConnector"><a href="classes/browser.BrowserWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>BrowserWebSocketConnector</a></li><li data-refl="141" id="node.NodeWebSocketConnector"><a href="classes/node.NodeWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>NodeWebSocketConnector</a></li><li data-refl="223" id="mock.MockWebSocketConnector"><a href="classes/mock.MockWebSocketConnector.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>MockWebSocketConnector</a></li></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/tsdotnet/websocket-connector" class="tsd-nav-link">GitHub</a><a href="https://www.npmjs.com/package/@tsdotnet/websocket-connector" class="tsd-nav-link">npm</a></nav><nav class="tsd-navigation"><a href="modules.html">@tsdotnet/websocket-connector - v1.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)