Skip to content

Commit c251f4f

Browse files
committed
Removed old dependencies from package.json
1 parent 09ad246 commit c251f4f

File tree

4 files changed

+61
-9547
lines changed

4 files changed

+61
-9547
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ This flag allows you to configure the WebSocket server's IP-address. By default
5555
This will configure what port the WebSocket server will listen on. The default value has been set to <code>8080</code>. You can change this
5656
value if it clashes with other services running on your machine.
5757

58+
59+
5860
## Database configuration
5961

6062
This server can run either with or without a database. By default i have disabled the use of a database server (<code>ENABLE_DATABASE</code>) but you can enable it by switching the <code>ENABLE_DATABASE</code> to <code>true</code>

docs/js/api.md

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,28 @@
1212
<dt><a href="#dom">dom(selector)</a> ⇒ <code><a href="#Dom">Dom</a></code></dt>
1313
<dd><p>Return a new instance of _dom (the jquery clone) so the code could</p>
1414
</dd>
15-
<dt><a href="#clear_userlist">clear_userlist()</a></dt>
15+
<dt><a href="#clearUserlist">clearUserlist()</a></dt>
1616
<dd><p>Remove all users from the users on the
1717
side of the screen.</p>
1818
</dd>
19-
<dt><a href="#dialog_output">dialog_output(pkg)</a></dt>
19+
<dt><a href="#dialogOutput">dialogOutput(pkg)</a></dt>
2020
<dd><p>Put a package (message) on the screen
2121
for you or others to read.</p>
2222
</dd>
23-
<dt><a href="#users_output">users_output(users)</a></dt>
23+
<dt><a href="#usersOutput">usersOutput(users)</a></dt>
2424
<dd><p>Update the user list in the UI</p>
2525
</dd>
26-
<dt><a href="#register_client">register_client()</a></dt>
26+
<dt><a href="#registerClient">registerClient()</a></dt>
2727
<dd><p>We need to register this browser window (client)
2828
to the server. We do this so we can sent private
2929
messages to other users.</p>
3030
</dd>
31-
<dt><a href="#request_userlist">request_userlist()</a></dt>
31+
<dt><a href="#requestUserlist">requestUserlist()</a></dt>
3232
<dd><p>Request a list of current active
3333
chat users. We do this every x seconds
3434
so we can update the ui.</p>
3535
</dd>
36-
<dt><a href="#send_message">send_message()</a></dt>
36+
<dt><a href="#sendMessage">sendMessage()</a></dt>
3737
<dd><p>Send a chat message to the server</p>
3838
</dd>
3939
</dl>
@@ -47,7 +47,6 @@ This file provides a replacement for jquery.
4747

4848
* [Dom](#Dom)
4949
* [new Dom(selector)](#new_Dom_new)
50-
* [.on](#Dom+on)
5150
* [.hide()](#Dom+hide)
5251
* [.show()](#Dom+show)
5352
* [.get()](#Dom+get) ⇒ <code>HTMLElement</code> \| <code>HTMLSelectElement</code> \| <code>HTMLLegendElement</code> \| <code>HTMLTableCaptionElement</code> \| <code>HTMLTextAreaElement</code> \| <code>HTMLModElement</code> \| <code>HTMLHRElement</code> \| <code>HTMLOutputElement</code> \| <code>HTMLPreElement</code> \| <code>HTMLEmbedElement</code> \| <code>HTMLCanvasElement</code> \| <code>HTMLFrameSetElement</code> \| <code>HTMLMarqueeElement</code> \| <code>HTMLScriptElement</code> \| <code>HTMLInputElement</code> \| <code>HTMLUnknownElement</code> \| <code>HTMLMetaElement</code> \| <code>HTMLStyleElement</code> \| <code>HTMLObjectElement</code> \| <code>HTMLTemplateElement</code> \| <code>HTMLBRElement</code> \| <code>HTMLAudioElement</code> \| <code>HTMLIFrameElement</code> \| <code>HTMLMapElement</code> \| <code>HTMLTableElement</code> \| <code>HTMLAnchorElement</code> \| <code>HTMLMenuElement</code> \| <code>HTMLPictureElement</code> \| <code>HTMLParagraphElement</code> \| <code>HTMLTableDataCellElement</code> \| <code>HTMLTableSectionElement</code> \| <code>HTMLQuoteElement</code> \| <code>HTMLTableHeaderCellElement</code> \| <code>HTMLProgressElement</code> \| <code>HTMLLIElement</code> \| <code>HTMLTableRowElement</code> \| <code>HTMLFontElement</code> \| <code>HTMLSpanElement</code> \| <code>HTMLTableColElement</code> \| <code>HTMLOptGroupElement</code> \| <code>HTMLDataElement</code> \| <code>HTMLDListElement</code> \| <code>HTMLFieldSetElement</code> \| <code>HTMLSourceElement</code> \| <code>HTMLBodyElement</code> \| <code>HTMLDirectoryElement</code> \| <code>HTMLDivElement</code> \| <code>HTMLUListElement</code> \| <code>HTMLHtmlElement</code> \| <code>HTMLAreaElement</code> \| <code>HTMLMeterElement</code> \| <code>HTMLAppletElement</code> \| <code>HTMLFrameElement</code> \| <code>HTMLOptionElement</code> \| <code>HTMLImageElement</code> \| <code>HTMLLinkElement</code> \| <code>HTMLHeadingElement</code> \| <code>HTMLSlotElement</code> \| <code>HTMLVideoElement</code> \| <code>HTMLBaseFontElement</code> \| <code>HTMLTitleElement</code> \| <code>HTMLButtonElement</code> \| <code>HTMLHeadElement</code> \| <code>HTMLParamElement</code> \| <code>HTMLTrackElement</code> \| <code>HTMLOListElement</code> \| <code>HTMLDataListElement</code> \| <code>HTMLLabelElement</code> \| <code>HTMLFormElement</code> \| <code>HTMLTimeElement</code> \| <code>HTMLBaseElement</code> \| <code>null</code> \| <code>\*</code>
@@ -58,6 +57,7 @@ This file provides a replacement for jquery.
5857
* [.text([value])](#Dom+text) ⇒ <code>string</code> \| <code>number</code>
5958
* [.addClass(className)](#Dom+addClass)
6059
* [.removeClass(className)](#Dom+removeClass)
60+
* [.on(event, callback)](#Dom+on)
6161

6262
<a name="new_Dom_new"></a>
6363

@@ -69,18 +69,6 @@ Construct with a selector that's all to it.
6969
| --- | --- | --- |
7070
| selector | <code>string</code> | The selector for the element to query. |
7171

72-
<a name="Dom+on"></a>
73-
74-
### dom.on
75-
Ad a EventListener for the dom element
76-
77-
**Kind**: instance property of [<code>Dom</code>](#Dom)
78-
79-
| Param | Type | Description |
80-
| --- | --- | --- |
81-
| event | <code>Event</code> | The event name. |
82-
| callback | | |
83-
8472
<a name="Dom+hide"></a>
8573

8674
### dom.hide()
@@ -109,7 +97,7 @@ Get or set a property on a dom element. Don't passthe value parameter if you wa
10997
| Param | Type | Default | Description |
11098
| --- | --- | --- | --- |
11199
| attribute | <code>string</code> | | The attribute name |
112-
| [value] | <code>string</code> | <code>null</code> | Value to set (optional) |
100+
| [value] | <code>string</code> | <code>&quot;&#x27;&#x27;&quot;</code> | Value to set (optional) |
113101

114102
<a name="Dom+removeAttr"></a>
115103

@@ -177,6 +165,18 @@ Remove a class from the given element
177165
| --- | --- | --- |
178166
| className | <code>string</code> | Classname to remove. |
179167

168+
<a name="Dom+on"></a>
169+
170+
### dom.on(event, callback)
171+
Ad a EventListener for the dom element
172+
173+
**Kind**: instance method of [<code>Dom</code>](#Dom)
174+
175+
| Param | Type | Description |
176+
| --- | --- | --- |
177+
| event | <code>string</code> | The event name. |
178+
| callback | | |
179+
180180
<a name="dom"></a>
181181

182182
## dom(selector) ⇒ [<code>Dom</code>](#Dom)
@@ -188,15 +188,15 @@ Return a new instance of _dom (the jquery clone) so the code could
188188
| --- | --- | --- |
189189
| selector | <code>string</code> | The selector for the dom element. |
190190

191-
<a name="clear_userlist"></a>
191+
<a name="clearUserlist"></a>
192192

193-
## clear_userlist()
193+
## clearUserlist()
194194
Remove all users from the users on theside of the screen.
195195

196196
**Kind**: global function
197-
<a name="dialog_output"></a>
197+
<a name="dialogOutput"></a>
198198

199-
## dialog_output(pkg)
199+
## dialogOutput(pkg)
200200
Put a package (message) on the screenfor you or others to read.
201201

202202
**Kind**: global function
@@ -205,9 +205,9 @@ Put a package (message) on the screenfor you or others to read.
205205
| --- | --- | --- |
206206
| pkg | <code>object</code> | The package object to display. |
207207

208-
<a name="users_output"></a>
208+
<a name="usersOutput"></a>
209209

210-
## users_output(users)
210+
## usersOutput(users)
211211
Update the user list in the UI
212212

213213
**Kind**: global function
@@ -216,64 +216,64 @@ Update the user list in the UI
216216
| --- | --- | --- |
217217
| users | <code>array</code> | Array of uses to display in the chatroom. |
218218

219-
<a name="users_output..selected_user"></a>
219+
<a name="usersOutput..selectedUser"></a>
220220

221-
### users_output~selected_user
221+
### usersOutput~selectedUser
222222
First get the current select valueon the list. This is so we can restorethe selected list item after requestingfow new users.
223223

224-
**Kind**: inner property of [<code>users_output</code>](#users_output)
225-
<a name="register_client"></a>
224+
**Kind**: inner constant of [<code>usersOutput</code>](#usersOutput)
225+
<a name="registerClient"></a>
226226

227-
## register_client()
227+
## registerClient()
228228
We need to register this browser window (client)to the server. We do this so we can sent privatemessages to other users.
229229

230230
**Kind**: global function
231-
<a name="register_client..pkg"></a>
231+
<a name="registerClient..pkg"></a>
232232

233-
### register_client~pkg
233+
### registerClient~pkg
234234
Create a registration package to send to theserver.
235235

236-
**Kind**: inner property of [<code>register_client</code>](#register_client)
237-
<a name="request_userlist"></a>
236+
**Kind**: inner property of [<code>registerClient</code>](#registerClient)
237+
<a name="requestUserlist"></a>
238238

239-
## request_userlist()
239+
## requestUserlist()
240240
Request a list of current activechat users. We do this every x secondsso we can update the ui.
241241

242242
**Kind**: global function
243-
<a name="send_message"></a>
243+
<a name="sendMessage"></a>
244244

245-
## send_message()
245+
## sendMessage()
246246
Send a chat message to the server
247247

248248
**Kind**: global function
249249

250-
* [send_message()](#send_message)
251-
* [~chat_message](#send_message..chat_message) : <code>string</code>
252-
* [~to_user](#send_message..to_user) : <code>string</code>
253-
* [~pkg](#send_message..pkg)
254-
* [~pkg_object](#send_message..pkg_object) : <code>Object</code>
250+
* [sendMessage()](#sendMessage)
251+
* [~toUser](#sendMessage..toUser) : <code>Object</code>
252+
* [~pkg](#sendMessage..pkg)
253+
* [~chatMessage](#sendMessage..chatMessage) : <code>string</code>
254+
* [~pkgObject](#sendMessage..pkgObject) : <code>Object</code>
255255

256-
<a name="send_message..chat_message"></a>
256+
<a name="sendMessage..toUser"></a>
257257

258-
### send_message~chat_message : <code>string</code>
259-
Catch the chat text
260-
261-
**Kind**: inner property of [<code>send_message</code>](#send_message)
262-
<a name="send_message..to_user"></a>
263-
264-
### send_message~to_user : <code>string</code>
258+
### sendMessage~toUser : <code>Object</code>
265259
When to_user is empty themessage will be sent to all usersin the chat room.
266260

267-
**Kind**: inner property of [<code>send_message</code>](#send_message)
268-
<a name="send_message..pkg"></a>
261+
**Kind**: inner property of [<code>sendMessage</code>](#sendMessage)
262+
<a name="sendMessage..pkg"></a>
269263

270-
### send_message~pkg
264+
### sendMessage~pkg
271265
Create a package to send to theserver.
272266

273-
**Kind**: inner property of [<code>send_message</code>](#send_message)
274-
<a name="send_message..pkg_object"></a>
267+
**Kind**: inner property of [<code>sendMessage</code>](#sendMessage)
268+
<a name="sendMessage..chatMessage"></a>
269+
270+
### sendMessage~chatMessage : <code>string</code>
271+
Catch the chat text
272+
273+
**Kind**: inner constant of [<code>sendMessage</code>](#sendMessage)
274+
<a name="sendMessage..pkgObject"></a>
275275

276-
### send_message~pkg_object : <code>Object</code>
276+
### sendMessage~pkgObject : <code>Object</code>
277277
We need a object copy of packageto send to dialog_output() but wealso want to turn the original packageinto a string so we can send it over thesocket to the server.
278278

279-
**Kind**: inner property of [<code>send_message</code>](#send_message)
279+
**Kind**: inner constant of [<code>sendMessage</code>](#sendMessage)

0 commit comments

Comments
 (0)