UrgentcareCLI 0.1.1 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (318) hide show
  1. checksums.yaml +4 -4
  2. data/lib/UrgentCare/CLI.rb +57 -22
  3. data/lib/UrgentCare/Office.rb +1 -5
  4. data/lib/UrgentCare/Scraper.rb +71 -0
  5. data/lib/UrgentCare/version.rb +2 -2
  6. data/lib/UrgentCare.rb +2 -1
  7. metadata +27 -321
  8. data/.gitignore +0 -11
  9. data/.rspec +0 -3
  10. data/.travis.yml +0 -5
  11. data/CODE_OF_CONDUCT.md +0 -74
  12. data/Gemfile +0 -12
  13. data/Gemfile.lock +0 -84
  14. data/LICENSE.txt +0 -21
  15. data/Notes +0 -41
  16. data/README.md +0 -41
  17. data/Rakefile +0 -8
  18. data/UrgentCare.gemspec +0 -39
  19. data/background.jpg +0 -0
  20. data/data.txt +0 -4
  21. data/lib/Urgentcare/Scraper.rb +0 -78
  22. data/node_modules/.bin/rimraf +0 -1
  23. data/node_modules/.package-lock.json +0 -250
  24. data/node_modules/balanced-match/.github/FUNDING.yml +0 -2
  25. data/node_modules/balanced-match/LICENSE.md +0 -21
  26. data/node_modules/balanced-match/README.md +0 -97
  27. data/node_modules/balanced-match/index.js +0 -62
  28. data/node_modules/balanced-match/package.json +0 -48
  29. data/node_modules/brace-expansion/LICENSE +0 -21
  30. data/node_modules/brace-expansion/README.md +0 -129
  31. data/node_modules/brace-expansion/index.js +0 -201
  32. data/node_modules/brace-expansion/package.json +0 -47
  33. data/node_modules/concat-map/.travis.yml +0 -4
  34. data/node_modules/concat-map/LICENSE +0 -18
  35. data/node_modules/concat-map/README.markdown +0 -62
  36. data/node_modules/concat-map/example/map.js +0 -6
  37. data/node_modules/concat-map/index.js +0 -13
  38. data/node_modules/concat-map/package.json +0 -43
  39. data/node_modules/concat-map/test/map.js +0 -39
  40. data/node_modules/core-util-is/LICENSE +0 -19
  41. data/node_modules/core-util-is/README.md +0 -3
  42. data/node_modules/core-util-is/float.patch +0 -604
  43. data/node_modules/core-util-is/lib/util.js +0 -107
  44. data/node_modules/core-util-is/package.json +0 -32
  45. data/node_modules/core-util-is/test.js +0 -68
  46. data/node_modules/fs.realpath/LICENSE +0 -43
  47. data/node_modules/fs.realpath/README.md +0 -33
  48. data/node_modules/fs.realpath/index.js +0 -66
  49. data/node_modules/fs.realpath/old.js +0 -303
  50. data/node_modules/fs.realpath/package.json +0 -26
  51. data/node_modules/glob/LICENSE +0 -21
  52. data/node_modules/glob/README.md +0 -375
  53. data/node_modules/glob/changelog.md +0 -67
  54. data/node_modules/glob/common.js +0 -234
  55. data/node_modules/glob/glob.js +0 -788
  56. data/node_modules/glob/package.json +0 -51
  57. data/node_modules/glob/sync.js +0 -484
  58. data/node_modules/immediate/LICENSE.txt +0 -20
  59. data/node_modules/immediate/README.md +0 -93
  60. data/node_modules/immediate/dist/immediate.js +0 -75
  61. data/node_modules/immediate/dist/immediate.min.js +0 -1
  62. data/node_modules/immediate/lib/browser.js +0 -69
  63. data/node_modules/immediate/lib/index.js +0 -73
  64. data/node_modules/immediate/package.json +0 -42
  65. data/node_modules/inflight/LICENSE +0 -15
  66. data/node_modules/inflight/README.md +0 -37
  67. data/node_modules/inflight/inflight.js +0 -54
  68. data/node_modules/inflight/package.json +0 -29
  69. data/node_modules/inherits/LICENSE +0 -16
  70. data/node_modules/inherits/README.md +0 -42
  71. data/node_modules/inherits/inherits.js +0 -9
  72. data/node_modules/inherits/inherits_browser.js +0 -27
  73. data/node_modules/inherits/package.json +0 -29
  74. data/node_modules/isarray/.npmignore +0 -1
  75. data/node_modules/isarray/.travis.yml +0 -4
  76. data/node_modules/isarray/Makefile +0 -6
  77. data/node_modules/isarray/README.md +0 -60
  78. data/node_modules/isarray/component.json +0 -19
  79. data/node_modules/isarray/index.js +0 -5
  80. data/node_modules/isarray/package.json +0 -45
  81. data/node_modules/isarray/test.js +0 -20
  82. data/node_modules/jszip/.codeclimate.yml +0 -16
  83. data/node_modules/jszip/.editorconfig +0 -8
  84. data/node_modules/jszip/.jshintignore +0 -1
  85. data/node_modules/jszip/.jshintrc +0 -21
  86. data/node_modules/jszip/.travis.yml +0 -17
  87. data/node_modules/jszip/CHANGES.md +0 -163
  88. data/node_modules/jszip/LICENSE.markdown +0 -651
  89. data/node_modules/jszip/README.markdown +0 -35
  90. data/node_modules/jszip/dist/jszip.js +0 -30
  91. data/node_modules/jszip/dist/jszip.min.js +0 -13
  92. data/node_modules/jszip/index.d.ts +0 -270
  93. data/node_modules/jszip/lib/base64.js +0 -106
  94. data/node_modules/jszip/lib/compressedObject.js +0 -74
  95. data/node_modules/jszip/lib/compressions.js +0 -14
  96. data/node_modules/jszip/lib/crc32.js +0 -77
  97. data/node_modules/jszip/lib/defaults.js +0 -11
  98. data/node_modules/jszip/lib/external.js +0 -19
  99. data/node_modules/jszip/lib/flate.js +0 -85
  100. data/node_modules/jszip/lib/generate/ZipFileWorker.js +0 -540
  101. data/node_modules/jszip/lib/generate/index.js +0 -57
  102. data/node_modules/jszip/lib/index.js +0 -52
  103. data/node_modules/jszip/lib/license_header.js +0 -11
  104. data/node_modules/jszip/lib/load.js +0 -81
  105. data/node_modules/jszip/lib/nodejs/NodejsStreamInputAdapter.js +0 -74
  106. data/node_modules/jszip/lib/nodejs/NodejsStreamOutputAdapter.js +0 -42
  107. data/node_modules/jszip/lib/nodejsUtils.js +0 -57
  108. data/node_modules/jszip/lib/object.js +0 -389
  109. data/node_modules/jszip/lib/readable-stream-browser.js +0 -9
  110. data/node_modules/jszip/lib/reader/ArrayReader.js +0 -57
  111. data/node_modules/jszip/lib/reader/DataReader.js +0 -116
  112. data/node_modules/jszip/lib/reader/NodeBufferReader.js +0 -19
  113. data/node_modules/jszip/lib/reader/StringReader.js +0 -38
  114. data/node_modules/jszip/lib/reader/Uint8ArrayReader.js +0 -22
  115. data/node_modules/jszip/lib/reader/readerFor.js +0 -28
  116. data/node_modules/jszip/lib/signature.js +0 -7
  117. data/node_modules/jszip/lib/stream/ConvertWorker.js +0 -26
  118. data/node_modules/jszip/lib/stream/Crc32Probe.js +0 -24
  119. data/node_modules/jszip/lib/stream/DataLengthProbe.js +0 -29
  120. data/node_modules/jszip/lib/stream/DataWorker.js +0 -116
  121. data/node_modules/jszip/lib/stream/GenericWorker.js +0 -263
  122. data/node_modules/jszip/lib/stream/StreamHelper.js +0 -212
  123. data/node_modules/jszip/lib/support.js +0 -38
  124. data/node_modules/jszip/lib/utf8.js +0 -275
  125. data/node_modules/jszip/lib/utils.js +0 -476
  126. data/node_modules/jszip/lib/zipEntries.js +0 -262
  127. data/node_modules/jszip/lib/zipEntry.js +0 -294
  128. data/node_modules/jszip/lib/zipObject.js +0 -133
  129. data/node_modules/jszip/package.json +0 -63
  130. data/node_modules/jszip/vendor/FileSaver.js +0 -247
  131. data/node_modules/lie/README.md +0 -62
  132. data/node_modules/lie/dist/lie.js +0 -350
  133. data/node_modules/lie/dist/lie.min.js +0 -1
  134. data/node_modules/lie/dist/lie.polyfill.js +0 -358
  135. data/node_modules/lie/dist/lie.polyfill.min.js +0 -1
  136. data/node_modules/lie/lib/browser.js +0 -273
  137. data/node_modules/lie/lib/index.js +0 -298
  138. data/node_modules/lie/license.md +0 -7
  139. data/node_modules/lie/lie.d.ts +0 -244
  140. data/node_modules/lie/package.json +0 -69
  141. data/node_modules/lie/polyfill.js +0 -4
  142. data/node_modules/minimatch/LICENSE +0 -15
  143. data/node_modules/minimatch/README.md +0 -209
  144. data/node_modules/minimatch/minimatch.js +0 -923
  145. data/node_modules/minimatch/package.json +0 -30
  146. data/node_modules/once/LICENSE +0 -15
  147. data/node_modules/once/README.md +0 -79
  148. data/node_modules/once/once.js +0 -42
  149. data/node_modules/once/package.json +0 -33
  150. data/node_modules/pako/CHANGELOG.md +0 -164
  151. data/node_modules/pako/LICENSE +0 -21
  152. data/node_modules/pako/README.md +0 -191
  153. data/node_modules/pako/dist/pako.js +0 -6818
  154. data/node_modules/pako/dist/pako.min.js +0 -1
  155. data/node_modules/pako/dist/pako_deflate.js +0 -3997
  156. data/node_modules/pako/dist/pako_deflate.min.js +0 -1
  157. data/node_modules/pako/dist/pako_inflate.js +0 -3300
  158. data/node_modules/pako/dist/pako_inflate.min.js +0 -1
  159. data/node_modules/pako/index.js +0 -14
  160. data/node_modules/pako/lib/deflate.js +0 -400
  161. data/node_modules/pako/lib/inflate.js +0 -423
  162. data/node_modules/pako/lib/utils/common.js +0 -105
  163. data/node_modules/pako/lib/utils/strings.js +0 -187
  164. data/node_modules/pako/lib/zlib/README +0 -59
  165. data/node_modules/pako/lib/zlib/adler32.js +0 -51
  166. data/node_modules/pako/lib/zlib/constants.js +0 -68
  167. data/node_modules/pako/lib/zlib/crc32.js +0 -59
  168. data/node_modules/pako/lib/zlib/deflate.js +0 -1874
  169. data/node_modules/pako/lib/zlib/gzheader.js +0 -58
  170. data/node_modules/pako/lib/zlib/inffast.js +0 -345
  171. data/node_modules/pako/lib/zlib/inflate.js +0 -1556
  172. data/node_modules/pako/lib/zlib/inftrees.js +0 -343
  173. data/node_modules/pako/lib/zlib/messages.js +0 -32
  174. data/node_modules/pako/lib/zlib/trees.js +0 -1222
  175. data/node_modules/pako/lib/zlib/zstream.js +0 -47
  176. data/node_modules/pako/package.json +0 -44
  177. data/node_modules/path-is-absolute/index.js +0 -20
  178. data/node_modules/path-is-absolute/license +0 -21
  179. data/node_modules/path-is-absolute/package.json +0 -43
  180. data/node_modules/path-is-absolute/readme.md +0 -59
  181. data/node_modules/process-nextick-args/index.js +0 -45
  182. data/node_modules/process-nextick-args/license.md +0 -19
  183. data/node_modules/process-nextick-args/package.json +0 -25
  184. data/node_modules/process-nextick-args/readme.md +0 -18
  185. data/node_modules/readable-stream/.travis.yml +0 -34
  186. data/node_modules/readable-stream/CONTRIBUTING.md +0 -38
  187. data/node_modules/readable-stream/GOVERNANCE.md +0 -136
  188. data/node_modules/readable-stream/LICENSE +0 -47
  189. data/node_modules/readable-stream/README.md +0 -58
  190. data/node_modules/readable-stream/doc/wg-meetings/2015-01-30.md +0 -60
  191. data/node_modules/readable-stream/duplex-browser.js +0 -1
  192. data/node_modules/readable-stream/duplex.js +0 -1
  193. data/node_modules/readable-stream/lib/_stream_duplex.js +0 -131
  194. data/node_modules/readable-stream/lib/_stream_passthrough.js +0 -47
  195. data/node_modules/readable-stream/lib/_stream_readable.js +0 -1019
  196. data/node_modules/readable-stream/lib/_stream_transform.js +0 -214
  197. data/node_modules/readable-stream/lib/_stream_writable.js +0 -687
  198. data/node_modules/readable-stream/lib/internal/streams/BufferList.js +0 -79
  199. data/node_modules/readable-stream/lib/internal/streams/destroy.js +0 -74
  200. data/node_modules/readable-stream/lib/internal/streams/stream-browser.js +0 -1
  201. data/node_modules/readable-stream/lib/internal/streams/stream.js +0 -1
  202. data/node_modules/readable-stream/package.json +0 -52
  203. data/node_modules/readable-stream/passthrough.js +0 -1
  204. data/node_modules/readable-stream/readable-browser.js +0 -7
  205. data/node_modules/readable-stream/readable.js +0 -19
  206. data/node_modules/readable-stream/transform.js +0 -1
  207. data/node_modules/readable-stream/writable-browser.js +0 -1
  208. data/node_modules/readable-stream/writable.js +0 -8
  209. data/node_modules/rimraf/LICENSE +0 -15
  210. data/node_modules/rimraf/README.md +0 -101
  211. data/node_modules/rimraf/bin.js +0 -50
  212. data/node_modules/rimraf/package.json +0 -29
  213. data/node_modules/rimraf/rimraf.js +0 -372
  214. data/node_modules/safe-buffer/LICENSE +0 -21
  215. data/node_modules/safe-buffer/README.md +0 -584
  216. data/node_modules/safe-buffer/index.d.ts +0 -187
  217. data/node_modules/safe-buffer/index.js +0 -62
  218. data/node_modules/safe-buffer/package.json +0 -37
  219. data/node_modules/selenium-webdriver/CHANGES.md +0 -1114
  220. data/node_modules/selenium-webdriver/LICENSE +0 -202
  221. data/node_modules/selenium-webdriver/NOTICE +0 -2
  222. data/node_modules/selenium-webdriver/README.md +0 -229
  223. data/node_modules/selenium-webdriver/chrome.js +0 -295
  224. data/node_modules/selenium-webdriver/chromium.js +0 -829
  225. data/node_modules/selenium-webdriver/devtools/CDPConnection.js +0 -35
  226. data/node_modules/selenium-webdriver/edge.js +0 -224
  227. data/node_modules/selenium-webdriver/example/chrome_android.js +0 -45
  228. data/node_modules/selenium-webdriver/example/chrome_mobile_emulation.js +0 -46
  229. data/node_modules/selenium-webdriver/example/firefox_channels.js +0 -84
  230. data/node_modules/selenium-webdriver/example/google_search.js +0 -50
  231. data/node_modules/selenium-webdriver/example/google_search_test.js +0 -70
  232. data/node_modules/selenium-webdriver/example/headless.js +0 -63
  233. data/node_modules/selenium-webdriver/example/logging.js +0 -64
  234. data/node_modules/selenium-webdriver/firefox.js +0 -789
  235. data/node_modules/selenium-webdriver/http/index.js +0 -324
  236. data/node_modules/selenium-webdriver/http/util.js +0 -172
  237. data/node_modules/selenium-webdriver/ie.js +0 -503
  238. data/node_modules/selenium-webdriver/index.js +0 -825
  239. data/node_modules/selenium-webdriver/io/exec.js +0 -162
  240. data/node_modules/selenium-webdriver/io/index.js +0 -348
  241. data/node_modules/selenium-webdriver/io/zip.js +0 -223
  242. data/node_modules/selenium-webdriver/lib/atoms/find-elements.js +0 -123
  243. data/node_modules/selenium-webdriver/lib/atoms/get-attribute.js +0 -101
  244. data/node_modules/selenium-webdriver/lib/atoms/is-displayed.js +0 -101
  245. data/node_modules/selenium-webdriver/lib/atoms/mutation-listener.js +0 -55
  246. data/node_modules/selenium-webdriver/lib/by.js +0 -415
  247. data/node_modules/selenium-webdriver/lib/capabilities.js +0 -553
  248. data/node_modules/selenium-webdriver/lib/command.js +0 -206
  249. data/node_modules/selenium-webdriver/lib/error.js +0 -605
  250. data/node_modules/selenium-webdriver/lib/http.js +0 -704
  251. data/node_modules/selenium-webdriver/lib/input.js +0 -946
  252. data/node_modules/selenium-webdriver/lib/logging.js +0 -661
  253. data/node_modules/selenium-webdriver/lib/promise.js +0 -285
  254. data/node_modules/selenium-webdriver/lib/proxy.js +0 -212
  255. data/node_modules/selenium-webdriver/lib/session.js +0 -77
  256. data/node_modules/selenium-webdriver/lib/symbols.js +0 -37
  257. data/node_modules/selenium-webdriver/lib/until.js +0 -429
  258. data/node_modules/selenium-webdriver/lib/webdriver.js +0 -2919
  259. data/node_modules/selenium-webdriver/net/index.js +0 -107
  260. data/node_modules/selenium-webdriver/net/portprober.js +0 -75
  261. data/node_modules/selenium-webdriver/opera.js +0 -406
  262. data/node_modules/selenium-webdriver/package.json +0 -54
  263. data/node_modules/selenium-webdriver/proxy.js +0 -32
  264. data/node_modules/selenium-webdriver/remote/index.js +0 -624
  265. data/node_modules/selenium-webdriver/safari.js +0 -168
  266. data/node_modules/selenium-webdriver/testing/index.js +0 -504
  267. data/node_modules/set-immediate-shim/index.js +0 -7
  268. data/node_modules/set-immediate-shim/package.json +0 -34
  269. data/node_modules/set-immediate-shim/readme.md +0 -31
  270. data/node_modules/string_decoder/.travis.yml +0 -50
  271. data/node_modules/string_decoder/LICENSE +0 -48
  272. data/node_modules/string_decoder/README.md +0 -47
  273. data/node_modules/string_decoder/lib/string_decoder.js +0 -296
  274. data/node_modules/string_decoder/package.json +0 -31
  275. data/node_modules/tmp/CHANGELOG.md +0 -288
  276. data/node_modules/tmp/LICENSE +0 -21
  277. data/node_modules/tmp/README.md +0 -365
  278. data/node_modules/tmp/lib/tmp.js +0 -780
  279. data/node_modules/tmp/node_modules/.bin/rimraf +0 -1
  280. data/node_modules/tmp/node_modules/rimraf/CHANGELOG.md +0 -65
  281. data/node_modules/tmp/node_modules/rimraf/LICENSE +0 -15
  282. data/node_modules/tmp/node_modules/rimraf/README.md +0 -101
  283. data/node_modules/tmp/node_modules/rimraf/bin.js +0 -68
  284. data/node_modules/tmp/node_modules/rimraf/package.json +0 -32
  285. data/node_modules/tmp/node_modules/rimraf/rimraf.js +0 -360
  286. data/node_modules/tmp/package.json +0 -58
  287. data/node_modules/util-deprecate/History.md +0 -16
  288. data/node_modules/util-deprecate/LICENSE +0 -24
  289. data/node_modules/util-deprecate/README.md +0 -53
  290. data/node_modules/util-deprecate/browser.js +0 -67
  291. data/node_modules/util-deprecate/node.js +0 -6
  292. data/node_modules/util-deprecate/package.json +0 -27
  293. data/node_modules/wrappy/LICENSE +0 -15
  294. data/node_modules/wrappy/README.md +0 -36
  295. data/node_modules/wrappy/package.json +0 -29
  296. data/node_modules/wrappy/wrappy.js +0 -33
  297. data/node_modules/ws/LICENSE +0 -21
  298. data/node_modules/ws/README.md +0 -496
  299. data/node_modules/ws/browser.js +0 -8
  300. data/node_modules/ws/index.js +0 -10
  301. data/node_modules/ws/lib/buffer-util.js +0 -129
  302. data/node_modules/ws/lib/constants.js +0 -10
  303. data/node_modules/ws/lib/event-target.js +0 -184
  304. data/node_modules/ws/lib/extension.js +0 -223
  305. data/node_modules/ws/lib/limiter.js +0 -55
  306. data/node_modules/ws/lib/permessage-deflate.js +0 -517
  307. data/node_modules/ws/lib/receiver.js +0 -507
  308. data/node_modules/ws/lib/sender.js +0 -405
  309. data/node_modules/ws/lib/stream.js +0 -165
  310. data/node_modules/ws/lib/validation.js +0 -104
  311. data/node_modules/ws/lib/websocket-server.js +0 -418
  312. data/node_modules/ws/lib/websocket.js +0 -942
  313. data/node_modules/ws/package.json +0 -56
  314. data/package-lock.json +0 -458
  315. data/package.json +0 -5
  316. data/selenium.log +0 -1
  317. data/spec.md +0 -6
  318. data/test.data +0 -2110
@@ -1,496 +0,0 @@
1
- # ws: a Node.js WebSocket library
2
-
3
- [![Version npm](https://img.shields.io/npm/v/ws.svg?logo=npm)](https://www.npmjs.com/package/ws)
4
- [![Build](https://img.shields.io/github/workflow/status/websockets/ws/CI/master?label=build&logo=github)](https://github.com/websockets/ws/actions?query=workflow%3ACI+branch%3Amaster)
5
- [![Windows x86 Build](https://img.shields.io/appveyor/ci/lpinca/ws/master.svg?logo=appveyor)](https://ci.appveyor.com/project/lpinca/ws)
6
- [![Coverage Status](https://img.shields.io/coveralls/websockets/ws/master.svg)](https://coveralls.io/github/websockets/ws)
7
-
8
- ws is a simple to use, blazing fast, and thoroughly tested WebSocket client and
9
- server implementation.
10
-
11
- Passes the quite extensive Autobahn test suite: [server][server-report],
12
- [client][client-report].
13
-
14
- **Note**: This module does not work in the browser. The client in the docs is a
15
- reference to a back end with the role of a client in the WebSocket
16
- communication. Browser clients must use the native
17
- [`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
18
- object. To make the same code work seamlessly on Node.js and the browser, you
19
- can use one of the many wrappers available on npm, like
20
- [isomorphic-ws](https://github.com/heineiuo/isomorphic-ws).
21
-
22
- ## Table of Contents
23
-
24
- - [Protocol support](#protocol-support)
25
- - [Installing](#installing)
26
- - [Opt-in for performance and spec compliance](#opt-in-for-performance-and-spec-compliance)
27
- - [API docs](#api-docs)
28
- - [WebSocket compression](#websocket-compression)
29
- - [Usage examples](#usage-examples)
30
- - [Sending and receiving text data](#sending-and-receiving-text-data)
31
- - [Sending binary data](#sending-binary-data)
32
- - [Simple server](#simple-server)
33
- - [External HTTP/S server](#external-https-server)
34
- - [Multiple servers sharing a single HTTP/S server](#multiple-servers-sharing-a-single-https-server)
35
- - [Client authentication](#client-authentication)
36
- - [Server broadcast](#server-broadcast)
37
- - [echo.websocket.org demo](#echowebsocketorg-demo)
38
- - [Use the Node.js streams API](#use-the-nodejs-streams-api)
39
- - [Other examples](#other-examples)
40
- - [FAQ](#faq)
41
- - [How to get the IP address of the client?](#how-to-get-the-ip-address-of-the-client)
42
- - [How to detect and close broken connections?](#how-to-detect-and-close-broken-connections)
43
- - [How to connect via a proxy?](#how-to-connect-via-a-proxy)
44
- - [Changelog](#changelog)
45
- - [License](#license)
46
-
47
- ## Protocol support
48
-
49
- - **HyBi drafts 07-12** (Use the option `protocolVersion: 8`)
50
- - **HyBi drafts 13-17** (Current default, alternatively option
51
- `protocolVersion: 13`)
52
-
53
- ## Installing
54
-
55
- ```
56
- npm install ws
57
- ```
58
-
59
- ### Opt-in for performance
60
-
61
- There are 2 optional modules that can be installed along side with the ws
62
- module. These modules are binary addons which improve certain operations.
63
- Prebuilt binaries are available for the most popular platforms so you don't
64
- necessarily need to have a C++ compiler installed on your machine.
65
-
66
- - `npm install --save-optional bufferutil`: Allows to efficiently perform
67
- operations such as masking and unmasking the data payload of the WebSocket
68
- frames.
69
- - `npm install --save-optional utf-8-validate`: Allows to efficiently check if a
70
- message contains valid UTF-8.
71
-
72
- ## API docs
73
-
74
- See [`/doc/ws.md`](./doc/ws.md) for Node.js-like documentation of ws classes and
75
- utility functions.
76
-
77
- ## WebSocket compression
78
-
79
- ws supports the [permessage-deflate extension][permessage-deflate] which enables
80
- the client and server to negotiate a compression algorithm and its parameters,
81
- and then selectively apply it to the data payloads of each WebSocket message.
82
-
83
- The extension is disabled by default on the server and enabled by default on the
84
- client. It adds a significant overhead in terms of performance and memory
85
- consumption so we suggest to enable it only if it is really needed.
86
-
87
- Note that Node.js has a variety of issues with high-performance compression,
88
- where increased concurrency, especially on Linux, can lead to [catastrophic
89
- memory fragmentation][node-zlib-bug] and slow performance. If you intend to use
90
- permessage-deflate in production, it is worthwhile to set up a test
91
- representative of your workload and ensure Node.js/zlib will handle it with
92
- acceptable performance and memory usage.
93
-
94
- Tuning of permessage-deflate can be done via the options defined below. You can
95
- also use `zlibDeflateOptions` and `zlibInflateOptions`, which is passed directly
96
- into the creation of [raw deflate/inflate streams][node-zlib-deflaterawdocs].
97
-
98
- See [the docs][ws-server-options] for more options.
99
-
100
- ```js
101
- const WebSocket = require('ws');
102
-
103
- const wss = new WebSocket.Server({
104
- port: 8080,
105
- perMessageDeflate: {
106
- zlibDeflateOptions: {
107
- // See zlib defaults.
108
- chunkSize: 1024,
109
- memLevel: 7,
110
- level: 3
111
- },
112
- zlibInflateOptions: {
113
- chunkSize: 10 * 1024
114
- },
115
- // Other options settable:
116
- clientNoContextTakeover: true, // Defaults to negotiated value.
117
- serverNoContextTakeover: true, // Defaults to negotiated value.
118
- serverMaxWindowBits: 10, // Defaults to negotiated value.
119
- // Below options specified as default values.
120
- concurrencyLimit: 10, // Limits zlib concurrency for perf.
121
- threshold: 1024 // Size (in bytes) below which messages
122
- // should not be compressed.
123
- }
124
- });
125
- ```
126
-
127
- The client will only use the extension if it is supported and enabled on the
128
- server. To always disable the extension on the client set the
129
- `perMessageDeflate` option to `false`.
130
-
131
- ```js
132
- const WebSocket = require('ws');
133
-
134
- const ws = new WebSocket('ws://www.host.com/path', {
135
- perMessageDeflate: false
136
- });
137
- ```
138
-
139
- ## Usage examples
140
-
141
- ### Sending and receiving text data
142
-
143
- ```js
144
- const WebSocket = require('ws');
145
-
146
- const ws = new WebSocket('ws://www.host.com/path');
147
-
148
- ws.on('open', function open() {
149
- ws.send('something');
150
- });
151
-
152
- ws.on('message', function incoming(data) {
153
- console.log(data);
154
- });
155
- ```
156
-
157
- ### Sending binary data
158
-
159
- ```js
160
- const WebSocket = require('ws');
161
-
162
- const ws = new WebSocket('ws://www.host.com/path');
163
-
164
- ws.on('open', function open() {
165
- const array = new Float32Array(5);
166
-
167
- for (var i = 0; i < array.length; ++i) {
168
- array[i] = i / 2;
169
- }
170
-
171
- ws.send(array);
172
- });
173
- ```
174
-
175
- ### Simple server
176
-
177
- ```js
178
- const WebSocket = require('ws');
179
-
180
- const wss = new WebSocket.Server({ port: 8080 });
181
-
182
- wss.on('connection', function connection(ws) {
183
- ws.on('message', function incoming(message) {
184
- console.log('received: %s', message);
185
- });
186
-
187
- ws.send('something');
188
- });
189
- ```
190
-
191
- ### External HTTP/S server
192
-
193
- ```js
194
- const fs = require('fs');
195
- const https = require('https');
196
- const WebSocket = require('ws');
197
-
198
- const server = https.createServer({
199
- cert: fs.readFileSync('/path/to/cert.pem'),
200
- key: fs.readFileSync('/path/to/key.pem')
201
- });
202
- const wss = new WebSocket.Server({ server });
203
-
204
- wss.on('connection', function connection(ws) {
205
- ws.on('message', function incoming(message) {
206
- console.log('received: %s', message);
207
- });
208
-
209
- ws.send('something');
210
- });
211
-
212
- server.listen(8080);
213
- ```
214
-
215
- ### Multiple servers sharing a single HTTP/S server
216
-
217
- ```js
218
- const http = require('http');
219
- const WebSocket = require('ws');
220
- const url = require('url');
221
-
222
- const server = http.createServer();
223
- const wss1 = new WebSocket.Server({ noServer: true });
224
- const wss2 = new WebSocket.Server({ noServer: true });
225
-
226
- wss1.on('connection', function connection(ws) {
227
- // ...
228
- });
229
-
230
- wss2.on('connection', function connection(ws) {
231
- // ...
232
- });
233
-
234
- server.on('upgrade', function upgrade(request, socket, head) {
235
- const pathname = url.parse(request.url).pathname;
236
-
237
- if (pathname === '/foo') {
238
- wss1.handleUpgrade(request, socket, head, function done(ws) {
239
- wss1.emit('connection', ws, request);
240
- });
241
- } else if (pathname === '/bar') {
242
- wss2.handleUpgrade(request, socket, head, function done(ws) {
243
- wss2.emit('connection', ws, request);
244
- });
245
- } else {
246
- socket.destroy();
247
- }
248
- });
249
-
250
- server.listen(8080);
251
- ```
252
-
253
- ### Client authentication
254
-
255
- ```js
256
- const http = require('http');
257
- const WebSocket = require('ws');
258
-
259
- const server = http.createServer();
260
- const wss = new WebSocket.Server({ noServer: true });
261
-
262
- wss.on('connection', function connection(ws, request, client) {
263
- ws.on('message', function message(msg) {
264
- console.log(`Received message ${msg} from user ${client}`);
265
- });
266
- });
267
-
268
- server.on('upgrade', function upgrade(request, socket, head) {
269
- // This function is not defined on purpose. Implement it with your own logic.
270
- authenticate(request, (err, client) => {
271
- if (err || !client) {
272
- socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n');
273
- socket.destroy();
274
- return;
275
- }
276
-
277
- wss.handleUpgrade(request, socket, head, function done(ws) {
278
- wss.emit('connection', ws, request, client);
279
- });
280
- });
281
- });
282
-
283
- server.listen(8080);
284
- ```
285
-
286
- Also see the provided [example][session-parse-example] using `express-session`.
287
-
288
- ### Server broadcast
289
-
290
- A client WebSocket broadcasting to all connected WebSocket clients, including
291
- itself.
292
-
293
- ```js
294
- const WebSocket = require('ws');
295
-
296
- const wss = new WebSocket.Server({ port: 8080 });
297
-
298
- wss.on('connection', function connection(ws) {
299
- ws.on('message', function incoming(data) {
300
- wss.clients.forEach(function each(client) {
301
- if (client.readyState === WebSocket.OPEN) {
302
- client.send(data);
303
- }
304
- });
305
- });
306
- });
307
- ```
308
-
309
- A client WebSocket broadcasting to every other connected WebSocket clients,
310
- excluding itself.
311
-
312
- ```js
313
- const WebSocket = require('ws');
314
-
315
- const wss = new WebSocket.Server({ port: 8080 });
316
-
317
- wss.on('connection', function connection(ws) {
318
- ws.on('message', function incoming(data) {
319
- wss.clients.forEach(function each(client) {
320
- if (client !== ws && client.readyState === WebSocket.OPEN) {
321
- client.send(data);
322
- }
323
- });
324
- });
325
- });
326
- ```
327
-
328
- ### echo.websocket.org demo
329
-
330
- ```js
331
- const WebSocket = require('ws');
332
-
333
- const ws = new WebSocket('wss://echo.websocket.org/', {
334
- origin: 'https://websocket.org'
335
- });
336
-
337
- ws.on('open', function open() {
338
- console.log('connected');
339
- ws.send(Date.now());
340
- });
341
-
342
- ws.on('close', function close() {
343
- console.log('disconnected');
344
- });
345
-
346
- ws.on('message', function incoming(data) {
347
- console.log(`Roundtrip time: ${Date.now() - data} ms`);
348
-
349
- setTimeout(function timeout() {
350
- ws.send(Date.now());
351
- }, 500);
352
- });
353
- ```
354
-
355
- ### Use the Node.js streams API
356
-
357
- ```js
358
- const WebSocket = require('ws');
359
-
360
- const ws = new WebSocket('wss://echo.websocket.org/', {
361
- origin: 'https://websocket.org'
362
- });
363
-
364
- const duplex = WebSocket.createWebSocketStream(ws, { encoding: 'utf8' });
365
-
366
- duplex.pipe(process.stdout);
367
- process.stdin.pipe(duplex);
368
- ```
369
-
370
- ### Other examples
371
-
372
- For a full example with a browser client communicating with a ws server, see the
373
- examples folder.
374
-
375
- Otherwise, see the test cases.
376
-
377
- ## FAQ
378
-
379
- ### How to get the IP address of the client?
380
-
381
- The remote IP address can be obtained from the raw socket.
382
-
383
- ```js
384
- const WebSocket = require('ws');
385
-
386
- const wss = new WebSocket.Server({ port: 8080 });
387
-
388
- wss.on('connection', function connection(ws, req) {
389
- const ip = req.socket.remoteAddress;
390
- });
391
- ```
392
-
393
- When the server runs behind a proxy like NGINX, the de-facto standard is to use
394
- the `X-Forwarded-For` header.
395
-
396
- ```js
397
- wss.on('connection', function connection(ws, req) {
398
- const ip = req.headers['x-forwarded-for'].split(/\s*,\s*/)[0];
399
- });
400
- ```
401
-
402
- ### How to detect and close broken connections?
403
-
404
- Sometimes the link between the server and the client can be interrupted in a way
405
- that keeps both the server and the client unaware of the broken state of the
406
- connection (e.g. when pulling the cord).
407
-
408
- In these cases ping messages can be used as a means to verify that the remote
409
- endpoint is still responsive.
410
-
411
- ```js
412
- const WebSocket = require('ws');
413
-
414
- function noop() {}
415
-
416
- function heartbeat() {
417
- this.isAlive = true;
418
- }
419
-
420
- const wss = new WebSocket.Server({ port: 8080 });
421
-
422
- wss.on('connection', function connection(ws) {
423
- ws.isAlive = true;
424
- ws.on('pong', heartbeat);
425
- });
426
-
427
- const interval = setInterval(function ping() {
428
- wss.clients.forEach(function each(ws) {
429
- if (ws.isAlive === false) return ws.terminate();
430
-
431
- ws.isAlive = false;
432
- ws.ping(noop);
433
- });
434
- }, 30000);
435
-
436
- wss.on('close', function close() {
437
- clearInterval(interval);
438
- });
439
- ```
440
-
441
- Pong messages are automatically sent in response to ping messages as required by
442
- the spec.
443
-
444
- Just like the server example above your clients might as well lose connection
445
- without knowing it. You might want to add a ping listener on your clients to
446
- prevent that. A simple implementation would be:
447
-
448
- ```js
449
- const WebSocket = require('ws');
450
-
451
- function heartbeat() {
452
- clearTimeout(this.pingTimeout);
453
-
454
- // Use `WebSocket#terminate()`, which immediately destroys the connection,
455
- // instead of `WebSocket#close()`, which waits for the close timer.
456
- // Delay should be equal to the interval at which your server
457
- // sends out pings plus a conservative assumption of the latency.
458
- this.pingTimeout = setTimeout(() => {
459
- this.terminate();
460
- }, 30000 + 1000);
461
- }
462
-
463
- const client = new WebSocket('wss://echo.websocket.org/');
464
-
465
- client.on('open', heartbeat);
466
- client.on('ping', heartbeat);
467
- client.on('close', function clear() {
468
- clearTimeout(this.pingTimeout);
469
- });
470
- ```
471
-
472
- ### How to connect via a proxy?
473
-
474
- Use a custom `http.Agent` implementation like [https-proxy-agent][] or
475
- [socks-proxy-agent][].
476
-
477
- ## Changelog
478
-
479
- We're using the GitHub [releases][changelog] for changelog entries.
480
-
481
- ## License
482
-
483
- [MIT](LICENSE)
484
-
485
- [changelog]: https://github.com/websockets/ws/releases
486
- [client-report]: http://websockets.github.io/ws/autobahn/clients/
487
- [https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
488
- [node-zlib-bug]: https://github.com/nodejs/node/issues/8871
489
- [node-zlib-deflaterawdocs]:
490
- https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options
491
- [permessage-deflate]: https://tools.ietf.org/html/rfc7692
492
- [server-report]: http://websockets.github.io/ws/autobahn/servers/
493
- [session-parse-example]: ./examples/express-session-parse
494
- [socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
495
- [ws-server-options]:
496
- https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback
@@ -1,8 +0,0 @@
1
- 'use strict';
2
-
3
- module.exports = function () {
4
- throw new Error(
5
- 'ws does not work in the browser. Browser clients must use the native ' +
6
- 'WebSocket object'
7
- );
8
- };
@@ -1,10 +0,0 @@
1
- 'use strict';
2
-
3
- const WebSocket = require('./lib/websocket');
4
-
5
- WebSocket.createWebSocketStream = require('./lib/stream');
6
- WebSocket.Server = require('./lib/websocket-server');
7
- WebSocket.Receiver = require('./lib/receiver');
8
- WebSocket.Sender = require('./lib/sender');
9
-
10
- module.exports = WebSocket;
@@ -1,129 +0,0 @@
1
- 'use strict';
2
-
3
- const { EMPTY_BUFFER } = require('./constants');
4
-
5
- /**
6
- * Merges an array of buffers into a new buffer.
7
- *
8
- * @param {Buffer[]} list The array of buffers to concat
9
- * @param {Number} totalLength The total length of buffers in the list
10
- * @return {Buffer} The resulting buffer
11
- * @public
12
- */
13
- function concat(list, totalLength) {
14
- if (list.length === 0) return EMPTY_BUFFER;
15
- if (list.length === 1) return list[0];
16
-
17
- const target = Buffer.allocUnsafe(totalLength);
18
- let offset = 0;
19
-
20
- for (let i = 0; i < list.length; i++) {
21
- const buf = list[i];
22
- target.set(buf, offset);
23
- offset += buf.length;
24
- }
25
-
26
- if (offset < totalLength) return target.slice(0, offset);
27
-
28
- return target;
29
- }
30
-
31
- /**
32
- * Masks a buffer using the given mask.
33
- *
34
- * @param {Buffer} source The buffer to mask
35
- * @param {Buffer} mask The mask to use
36
- * @param {Buffer} output The buffer where to store the result
37
- * @param {Number} offset The offset at which to start writing
38
- * @param {Number} length The number of bytes to mask.
39
- * @public
40
- */
41
- function _mask(source, mask, output, offset, length) {
42
- for (let i = 0; i < length; i++) {
43
- output[offset + i] = source[i] ^ mask[i & 3];
44
- }
45
- }
46
-
47
- /**
48
- * Unmasks a buffer using the given mask.
49
- *
50
- * @param {Buffer} buffer The buffer to unmask
51
- * @param {Buffer} mask The mask to use
52
- * @public
53
- */
54
- function _unmask(buffer, mask) {
55
- // Required until https://github.com/nodejs/node/issues/9006 is resolved.
56
- const length = buffer.length;
57
- for (let i = 0; i < length; i++) {
58
- buffer[i] ^= mask[i & 3];
59
- }
60
- }
61
-
62
- /**
63
- * Converts a buffer to an `ArrayBuffer`.
64
- *
65
- * @param {Buffer} buf The buffer to convert
66
- * @return {ArrayBuffer} Converted buffer
67
- * @public
68
- */
69
- function toArrayBuffer(buf) {
70
- if (buf.byteLength === buf.buffer.byteLength) {
71
- return buf.buffer;
72
- }
73
-
74
- return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength);
75
- }
76
-
77
- /**
78
- * Converts `data` to a `Buffer`.
79
- *
80
- * @param {*} data The data to convert
81
- * @return {Buffer} The buffer
82
- * @throws {TypeError}
83
- * @public
84
- */
85
- function toBuffer(data) {
86
- toBuffer.readOnly = true;
87
-
88
- if (Buffer.isBuffer(data)) return data;
89
-
90
- let buf;
91
-
92
- if (data instanceof ArrayBuffer) {
93
- buf = Buffer.from(data);
94
- } else if (ArrayBuffer.isView(data)) {
95
- buf = Buffer.from(data.buffer, data.byteOffset, data.byteLength);
96
- } else {
97
- buf = Buffer.from(data);
98
- toBuffer.readOnly = false;
99
- }
100
-
101
- return buf;
102
- }
103
-
104
- try {
105
- const bufferUtil = require('bufferutil');
106
- const bu = bufferUtil.BufferUtil || bufferUtil;
107
-
108
- module.exports = {
109
- concat,
110
- mask(source, mask, output, offset, length) {
111
- if (length < 48) _mask(source, mask, output, offset, length);
112
- else bu.mask(source, mask, output, offset, length);
113
- },
114
- toArrayBuffer,
115
- toBuffer,
116
- unmask(buffer, mask) {
117
- if (buffer.length < 32) _unmask(buffer, mask);
118
- else bu.unmask(buffer, mask);
119
- }
120
- };
121
- } catch (e) /* istanbul ignore next */ {
122
- module.exports = {
123
- concat,
124
- mask: _mask,
125
- toArrayBuffer,
126
- toBuffer,
127
- unmask: _unmask
128
- };
129
- }
@@ -1,10 +0,0 @@
1
- 'use strict';
2
-
3
- module.exports = {
4
- BINARY_TYPES: ['nodebuffer', 'arraybuffer', 'fragments'],
5
- GUID: '258EAFA5-E914-47DA-95CA-C5AB0DC85B11',
6
- kStatusCode: Symbol('status-code'),
7
- kWebSocket: Symbol('websocket'),
8
- EMPTY_BUFFER: Buffer.alloc(0),
9
- NOOP: () => {}
10
- };