UrgentcareCLI 0.1.1 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (317) hide show
  1. checksums.yaml +4 -4
  2. data/lib/UrgentCare/CLI.rb +1 -2
  3. data/lib/UrgentCare/Scraper.rb +65 -0
  4. data/lib/UrgentCare/version.rb +2 -2
  5. data/lib/UrgentCare.rb +1 -0
  6. metadata +3 -313
  7. data/.gitignore +0 -11
  8. data/.rspec +0 -3
  9. data/.travis.yml +0 -5
  10. data/CODE_OF_CONDUCT.md +0 -74
  11. data/Gemfile +0 -12
  12. data/Gemfile.lock +0 -84
  13. data/LICENSE.txt +0 -21
  14. data/Notes +0 -41
  15. data/README.md +0 -41
  16. data/Rakefile +0 -8
  17. data/UrgentCare.gemspec +0 -39
  18. data/background.jpg +0 -0
  19. data/data.txt +0 -4
  20. data/lib/Urgentcare/Scraper.rb +0 -78
  21. data/node_modules/.bin/rimraf +0 -1
  22. data/node_modules/.package-lock.json +0 -250
  23. data/node_modules/balanced-match/.github/FUNDING.yml +0 -2
  24. data/node_modules/balanced-match/LICENSE.md +0 -21
  25. data/node_modules/balanced-match/README.md +0 -97
  26. data/node_modules/balanced-match/index.js +0 -62
  27. data/node_modules/balanced-match/package.json +0 -48
  28. data/node_modules/brace-expansion/LICENSE +0 -21
  29. data/node_modules/brace-expansion/README.md +0 -129
  30. data/node_modules/brace-expansion/index.js +0 -201
  31. data/node_modules/brace-expansion/package.json +0 -47
  32. data/node_modules/concat-map/.travis.yml +0 -4
  33. data/node_modules/concat-map/LICENSE +0 -18
  34. data/node_modules/concat-map/README.markdown +0 -62
  35. data/node_modules/concat-map/example/map.js +0 -6
  36. data/node_modules/concat-map/index.js +0 -13
  37. data/node_modules/concat-map/package.json +0 -43
  38. data/node_modules/concat-map/test/map.js +0 -39
  39. data/node_modules/core-util-is/LICENSE +0 -19
  40. data/node_modules/core-util-is/README.md +0 -3
  41. data/node_modules/core-util-is/float.patch +0 -604
  42. data/node_modules/core-util-is/lib/util.js +0 -107
  43. data/node_modules/core-util-is/package.json +0 -32
  44. data/node_modules/core-util-is/test.js +0 -68
  45. data/node_modules/fs.realpath/LICENSE +0 -43
  46. data/node_modules/fs.realpath/README.md +0 -33
  47. data/node_modules/fs.realpath/index.js +0 -66
  48. data/node_modules/fs.realpath/old.js +0 -303
  49. data/node_modules/fs.realpath/package.json +0 -26
  50. data/node_modules/glob/LICENSE +0 -21
  51. data/node_modules/glob/README.md +0 -375
  52. data/node_modules/glob/changelog.md +0 -67
  53. data/node_modules/glob/common.js +0 -234
  54. data/node_modules/glob/glob.js +0 -788
  55. data/node_modules/glob/package.json +0 -51
  56. data/node_modules/glob/sync.js +0 -484
  57. data/node_modules/immediate/LICENSE.txt +0 -20
  58. data/node_modules/immediate/README.md +0 -93
  59. data/node_modules/immediate/dist/immediate.js +0 -75
  60. data/node_modules/immediate/dist/immediate.min.js +0 -1
  61. data/node_modules/immediate/lib/browser.js +0 -69
  62. data/node_modules/immediate/lib/index.js +0 -73
  63. data/node_modules/immediate/package.json +0 -42
  64. data/node_modules/inflight/LICENSE +0 -15
  65. data/node_modules/inflight/README.md +0 -37
  66. data/node_modules/inflight/inflight.js +0 -54
  67. data/node_modules/inflight/package.json +0 -29
  68. data/node_modules/inherits/LICENSE +0 -16
  69. data/node_modules/inherits/README.md +0 -42
  70. data/node_modules/inherits/inherits.js +0 -9
  71. data/node_modules/inherits/inherits_browser.js +0 -27
  72. data/node_modules/inherits/package.json +0 -29
  73. data/node_modules/isarray/.npmignore +0 -1
  74. data/node_modules/isarray/.travis.yml +0 -4
  75. data/node_modules/isarray/Makefile +0 -6
  76. data/node_modules/isarray/README.md +0 -60
  77. data/node_modules/isarray/component.json +0 -19
  78. data/node_modules/isarray/index.js +0 -5
  79. data/node_modules/isarray/package.json +0 -45
  80. data/node_modules/isarray/test.js +0 -20
  81. data/node_modules/jszip/.codeclimate.yml +0 -16
  82. data/node_modules/jszip/.editorconfig +0 -8
  83. data/node_modules/jszip/.jshintignore +0 -1
  84. data/node_modules/jszip/.jshintrc +0 -21
  85. data/node_modules/jszip/.travis.yml +0 -17
  86. data/node_modules/jszip/CHANGES.md +0 -163
  87. data/node_modules/jszip/LICENSE.markdown +0 -651
  88. data/node_modules/jszip/README.markdown +0 -35
  89. data/node_modules/jszip/dist/jszip.js +0 -30
  90. data/node_modules/jszip/dist/jszip.min.js +0 -13
  91. data/node_modules/jszip/index.d.ts +0 -270
  92. data/node_modules/jszip/lib/base64.js +0 -106
  93. data/node_modules/jszip/lib/compressedObject.js +0 -74
  94. data/node_modules/jszip/lib/compressions.js +0 -14
  95. data/node_modules/jszip/lib/crc32.js +0 -77
  96. data/node_modules/jszip/lib/defaults.js +0 -11
  97. data/node_modules/jszip/lib/external.js +0 -19
  98. data/node_modules/jszip/lib/flate.js +0 -85
  99. data/node_modules/jszip/lib/generate/ZipFileWorker.js +0 -540
  100. data/node_modules/jszip/lib/generate/index.js +0 -57
  101. data/node_modules/jszip/lib/index.js +0 -52
  102. data/node_modules/jszip/lib/license_header.js +0 -11
  103. data/node_modules/jszip/lib/load.js +0 -81
  104. data/node_modules/jszip/lib/nodejs/NodejsStreamInputAdapter.js +0 -74
  105. data/node_modules/jszip/lib/nodejs/NodejsStreamOutputAdapter.js +0 -42
  106. data/node_modules/jszip/lib/nodejsUtils.js +0 -57
  107. data/node_modules/jszip/lib/object.js +0 -389
  108. data/node_modules/jszip/lib/readable-stream-browser.js +0 -9
  109. data/node_modules/jszip/lib/reader/ArrayReader.js +0 -57
  110. data/node_modules/jszip/lib/reader/DataReader.js +0 -116
  111. data/node_modules/jszip/lib/reader/NodeBufferReader.js +0 -19
  112. data/node_modules/jszip/lib/reader/StringReader.js +0 -38
  113. data/node_modules/jszip/lib/reader/Uint8ArrayReader.js +0 -22
  114. data/node_modules/jszip/lib/reader/readerFor.js +0 -28
  115. data/node_modules/jszip/lib/signature.js +0 -7
  116. data/node_modules/jszip/lib/stream/ConvertWorker.js +0 -26
  117. data/node_modules/jszip/lib/stream/Crc32Probe.js +0 -24
  118. data/node_modules/jszip/lib/stream/DataLengthProbe.js +0 -29
  119. data/node_modules/jszip/lib/stream/DataWorker.js +0 -116
  120. data/node_modules/jszip/lib/stream/GenericWorker.js +0 -263
  121. data/node_modules/jszip/lib/stream/StreamHelper.js +0 -212
  122. data/node_modules/jszip/lib/support.js +0 -38
  123. data/node_modules/jszip/lib/utf8.js +0 -275
  124. data/node_modules/jszip/lib/utils.js +0 -476
  125. data/node_modules/jszip/lib/zipEntries.js +0 -262
  126. data/node_modules/jszip/lib/zipEntry.js +0 -294
  127. data/node_modules/jszip/lib/zipObject.js +0 -133
  128. data/node_modules/jszip/package.json +0 -63
  129. data/node_modules/jszip/vendor/FileSaver.js +0 -247
  130. data/node_modules/lie/README.md +0 -62
  131. data/node_modules/lie/dist/lie.js +0 -350
  132. data/node_modules/lie/dist/lie.min.js +0 -1
  133. data/node_modules/lie/dist/lie.polyfill.js +0 -358
  134. data/node_modules/lie/dist/lie.polyfill.min.js +0 -1
  135. data/node_modules/lie/lib/browser.js +0 -273
  136. data/node_modules/lie/lib/index.js +0 -298
  137. data/node_modules/lie/license.md +0 -7
  138. data/node_modules/lie/lie.d.ts +0 -244
  139. data/node_modules/lie/package.json +0 -69
  140. data/node_modules/lie/polyfill.js +0 -4
  141. data/node_modules/minimatch/LICENSE +0 -15
  142. data/node_modules/minimatch/README.md +0 -209
  143. data/node_modules/minimatch/minimatch.js +0 -923
  144. data/node_modules/minimatch/package.json +0 -30
  145. data/node_modules/once/LICENSE +0 -15
  146. data/node_modules/once/README.md +0 -79
  147. data/node_modules/once/once.js +0 -42
  148. data/node_modules/once/package.json +0 -33
  149. data/node_modules/pako/CHANGELOG.md +0 -164
  150. data/node_modules/pako/LICENSE +0 -21
  151. data/node_modules/pako/README.md +0 -191
  152. data/node_modules/pako/dist/pako.js +0 -6818
  153. data/node_modules/pako/dist/pako.min.js +0 -1
  154. data/node_modules/pako/dist/pako_deflate.js +0 -3997
  155. data/node_modules/pako/dist/pako_deflate.min.js +0 -1
  156. data/node_modules/pako/dist/pako_inflate.js +0 -3300
  157. data/node_modules/pako/dist/pako_inflate.min.js +0 -1
  158. data/node_modules/pako/index.js +0 -14
  159. data/node_modules/pako/lib/deflate.js +0 -400
  160. data/node_modules/pako/lib/inflate.js +0 -423
  161. data/node_modules/pako/lib/utils/common.js +0 -105
  162. data/node_modules/pako/lib/utils/strings.js +0 -187
  163. data/node_modules/pako/lib/zlib/README +0 -59
  164. data/node_modules/pako/lib/zlib/adler32.js +0 -51
  165. data/node_modules/pako/lib/zlib/constants.js +0 -68
  166. data/node_modules/pako/lib/zlib/crc32.js +0 -59
  167. data/node_modules/pako/lib/zlib/deflate.js +0 -1874
  168. data/node_modules/pako/lib/zlib/gzheader.js +0 -58
  169. data/node_modules/pako/lib/zlib/inffast.js +0 -345
  170. data/node_modules/pako/lib/zlib/inflate.js +0 -1556
  171. data/node_modules/pako/lib/zlib/inftrees.js +0 -343
  172. data/node_modules/pako/lib/zlib/messages.js +0 -32
  173. data/node_modules/pako/lib/zlib/trees.js +0 -1222
  174. data/node_modules/pako/lib/zlib/zstream.js +0 -47
  175. data/node_modules/pako/package.json +0 -44
  176. data/node_modules/path-is-absolute/index.js +0 -20
  177. data/node_modules/path-is-absolute/license +0 -21
  178. data/node_modules/path-is-absolute/package.json +0 -43
  179. data/node_modules/path-is-absolute/readme.md +0 -59
  180. data/node_modules/process-nextick-args/index.js +0 -45
  181. data/node_modules/process-nextick-args/license.md +0 -19
  182. data/node_modules/process-nextick-args/package.json +0 -25
  183. data/node_modules/process-nextick-args/readme.md +0 -18
  184. data/node_modules/readable-stream/.travis.yml +0 -34
  185. data/node_modules/readable-stream/CONTRIBUTING.md +0 -38
  186. data/node_modules/readable-stream/GOVERNANCE.md +0 -136
  187. data/node_modules/readable-stream/LICENSE +0 -47
  188. data/node_modules/readable-stream/README.md +0 -58
  189. data/node_modules/readable-stream/doc/wg-meetings/2015-01-30.md +0 -60
  190. data/node_modules/readable-stream/duplex-browser.js +0 -1
  191. data/node_modules/readable-stream/duplex.js +0 -1
  192. data/node_modules/readable-stream/lib/_stream_duplex.js +0 -131
  193. data/node_modules/readable-stream/lib/_stream_passthrough.js +0 -47
  194. data/node_modules/readable-stream/lib/_stream_readable.js +0 -1019
  195. data/node_modules/readable-stream/lib/_stream_transform.js +0 -214
  196. data/node_modules/readable-stream/lib/_stream_writable.js +0 -687
  197. data/node_modules/readable-stream/lib/internal/streams/BufferList.js +0 -79
  198. data/node_modules/readable-stream/lib/internal/streams/destroy.js +0 -74
  199. data/node_modules/readable-stream/lib/internal/streams/stream-browser.js +0 -1
  200. data/node_modules/readable-stream/lib/internal/streams/stream.js +0 -1
  201. data/node_modules/readable-stream/package.json +0 -52
  202. data/node_modules/readable-stream/passthrough.js +0 -1
  203. data/node_modules/readable-stream/readable-browser.js +0 -7
  204. data/node_modules/readable-stream/readable.js +0 -19
  205. data/node_modules/readable-stream/transform.js +0 -1
  206. data/node_modules/readable-stream/writable-browser.js +0 -1
  207. data/node_modules/readable-stream/writable.js +0 -8
  208. data/node_modules/rimraf/LICENSE +0 -15
  209. data/node_modules/rimraf/README.md +0 -101
  210. data/node_modules/rimraf/bin.js +0 -50
  211. data/node_modules/rimraf/package.json +0 -29
  212. data/node_modules/rimraf/rimraf.js +0 -372
  213. data/node_modules/safe-buffer/LICENSE +0 -21
  214. data/node_modules/safe-buffer/README.md +0 -584
  215. data/node_modules/safe-buffer/index.d.ts +0 -187
  216. data/node_modules/safe-buffer/index.js +0 -62
  217. data/node_modules/safe-buffer/package.json +0 -37
  218. data/node_modules/selenium-webdriver/CHANGES.md +0 -1114
  219. data/node_modules/selenium-webdriver/LICENSE +0 -202
  220. data/node_modules/selenium-webdriver/NOTICE +0 -2
  221. data/node_modules/selenium-webdriver/README.md +0 -229
  222. data/node_modules/selenium-webdriver/chrome.js +0 -295
  223. data/node_modules/selenium-webdriver/chromium.js +0 -829
  224. data/node_modules/selenium-webdriver/devtools/CDPConnection.js +0 -35
  225. data/node_modules/selenium-webdriver/edge.js +0 -224
  226. data/node_modules/selenium-webdriver/example/chrome_android.js +0 -45
  227. data/node_modules/selenium-webdriver/example/chrome_mobile_emulation.js +0 -46
  228. data/node_modules/selenium-webdriver/example/firefox_channels.js +0 -84
  229. data/node_modules/selenium-webdriver/example/google_search.js +0 -50
  230. data/node_modules/selenium-webdriver/example/google_search_test.js +0 -70
  231. data/node_modules/selenium-webdriver/example/headless.js +0 -63
  232. data/node_modules/selenium-webdriver/example/logging.js +0 -64
  233. data/node_modules/selenium-webdriver/firefox.js +0 -789
  234. data/node_modules/selenium-webdriver/http/index.js +0 -324
  235. data/node_modules/selenium-webdriver/http/util.js +0 -172
  236. data/node_modules/selenium-webdriver/ie.js +0 -503
  237. data/node_modules/selenium-webdriver/index.js +0 -825
  238. data/node_modules/selenium-webdriver/io/exec.js +0 -162
  239. data/node_modules/selenium-webdriver/io/index.js +0 -348
  240. data/node_modules/selenium-webdriver/io/zip.js +0 -223
  241. data/node_modules/selenium-webdriver/lib/atoms/find-elements.js +0 -123
  242. data/node_modules/selenium-webdriver/lib/atoms/get-attribute.js +0 -101
  243. data/node_modules/selenium-webdriver/lib/atoms/is-displayed.js +0 -101
  244. data/node_modules/selenium-webdriver/lib/atoms/mutation-listener.js +0 -55
  245. data/node_modules/selenium-webdriver/lib/by.js +0 -415
  246. data/node_modules/selenium-webdriver/lib/capabilities.js +0 -553
  247. data/node_modules/selenium-webdriver/lib/command.js +0 -206
  248. data/node_modules/selenium-webdriver/lib/error.js +0 -605
  249. data/node_modules/selenium-webdriver/lib/http.js +0 -704
  250. data/node_modules/selenium-webdriver/lib/input.js +0 -946
  251. data/node_modules/selenium-webdriver/lib/logging.js +0 -661
  252. data/node_modules/selenium-webdriver/lib/promise.js +0 -285
  253. data/node_modules/selenium-webdriver/lib/proxy.js +0 -212
  254. data/node_modules/selenium-webdriver/lib/session.js +0 -77
  255. data/node_modules/selenium-webdriver/lib/symbols.js +0 -37
  256. data/node_modules/selenium-webdriver/lib/until.js +0 -429
  257. data/node_modules/selenium-webdriver/lib/webdriver.js +0 -2919
  258. data/node_modules/selenium-webdriver/net/index.js +0 -107
  259. data/node_modules/selenium-webdriver/net/portprober.js +0 -75
  260. data/node_modules/selenium-webdriver/opera.js +0 -406
  261. data/node_modules/selenium-webdriver/package.json +0 -54
  262. data/node_modules/selenium-webdriver/proxy.js +0 -32
  263. data/node_modules/selenium-webdriver/remote/index.js +0 -624
  264. data/node_modules/selenium-webdriver/safari.js +0 -168
  265. data/node_modules/selenium-webdriver/testing/index.js +0 -504
  266. data/node_modules/set-immediate-shim/index.js +0 -7
  267. data/node_modules/set-immediate-shim/package.json +0 -34
  268. data/node_modules/set-immediate-shim/readme.md +0 -31
  269. data/node_modules/string_decoder/.travis.yml +0 -50
  270. data/node_modules/string_decoder/LICENSE +0 -48
  271. data/node_modules/string_decoder/README.md +0 -47
  272. data/node_modules/string_decoder/lib/string_decoder.js +0 -296
  273. data/node_modules/string_decoder/package.json +0 -31
  274. data/node_modules/tmp/CHANGELOG.md +0 -288
  275. data/node_modules/tmp/LICENSE +0 -21
  276. data/node_modules/tmp/README.md +0 -365
  277. data/node_modules/tmp/lib/tmp.js +0 -780
  278. data/node_modules/tmp/node_modules/.bin/rimraf +0 -1
  279. data/node_modules/tmp/node_modules/rimraf/CHANGELOG.md +0 -65
  280. data/node_modules/tmp/node_modules/rimraf/LICENSE +0 -15
  281. data/node_modules/tmp/node_modules/rimraf/README.md +0 -101
  282. data/node_modules/tmp/node_modules/rimraf/bin.js +0 -68
  283. data/node_modules/tmp/node_modules/rimraf/package.json +0 -32
  284. data/node_modules/tmp/node_modules/rimraf/rimraf.js +0 -360
  285. data/node_modules/tmp/package.json +0 -58
  286. data/node_modules/util-deprecate/History.md +0 -16
  287. data/node_modules/util-deprecate/LICENSE +0 -24
  288. data/node_modules/util-deprecate/README.md +0 -53
  289. data/node_modules/util-deprecate/browser.js +0 -67
  290. data/node_modules/util-deprecate/node.js +0 -6
  291. data/node_modules/util-deprecate/package.json +0 -27
  292. data/node_modules/wrappy/LICENSE +0 -15
  293. data/node_modules/wrappy/README.md +0 -36
  294. data/node_modules/wrappy/package.json +0 -29
  295. data/node_modules/wrappy/wrappy.js +0 -33
  296. data/node_modules/ws/LICENSE +0 -21
  297. data/node_modules/ws/README.md +0 -496
  298. data/node_modules/ws/browser.js +0 -8
  299. data/node_modules/ws/index.js +0 -10
  300. data/node_modules/ws/lib/buffer-util.js +0 -129
  301. data/node_modules/ws/lib/constants.js +0 -10
  302. data/node_modules/ws/lib/event-target.js +0 -184
  303. data/node_modules/ws/lib/extension.js +0 -223
  304. data/node_modules/ws/lib/limiter.js +0 -55
  305. data/node_modules/ws/lib/permessage-deflate.js +0 -517
  306. data/node_modules/ws/lib/receiver.js +0 -507
  307. data/node_modules/ws/lib/sender.js +0 -405
  308. data/node_modules/ws/lib/stream.js +0 -165
  309. data/node_modules/ws/lib/validation.js +0 -104
  310. data/node_modules/ws/lib/websocket-server.js +0 -418
  311. data/node_modules/ws/lib/websocket.js +0 -942
  312. data/node_modules/ws/package.json +0 -56
  313. data/package-lock.json +0 -458
  314. data/package.json +0 -5
  315. data/selenium.log +0 -1
  316. data/spec.md +0 -6
  317. data/test.data +0 -2110
@@ -1,58 +0,0 @@
1
- {
2
- "name": "tmp",
3
- "version": "0.2.1",
4
- "description": "Temporary file and directory creator",
5
- "author": "KARASZI István <github@spam.raszi.hu> (http://raszi.hu/)",
6
- "contributors": [
7
- "Carsten Klein <trancesilken@gmail.com> (https://github.com/silkentrance)"
8
- ],
9
- "keywords": [
10
- "temporary",
11
- "tmp",
12
- "temp",
13
- "tempdir",
14
- "tempfile",
15
- "tmpdir",
16
- "tmpfile"
17
- ],
18
- "license": "MIT",
19
- "repository": "https://github.com/raszi/node-tmp.git",
20
- "homepage": "http://github.com/raszi/node-tmp",
21
- "bugs": {
22
- "url": "http://github.com/raszi/node-tmp/issues"
23
- },
24
- "engines": {
25
- "node": ">=8.17.0"
26
- },
27
- "dependencies": {
28
- "rimraf": "^3.0.0"
29
- },
30
- "devDependencies": {
31
- "eslint": "^6.3.0",
32
- "eslint-plugin-mocha": "^6.1.1",
33
- "istanbul": "^0.4.5",
34
- "lerna-changelog": "^1.0.1",
35
- "mocha": "^6.2.0"
36
- },
37
- "main": "lib/tmp.js",
38
- "files": [
39
- "lib/"
40
- ],
41
- "changelog": {
42
- "labels": {
43
- "breaking": ":boom: Breaking Change",
44
- "enhancement": ":rocket: Enhancement",
45
- "bug": ":bug: Bug Fix",
46
- "documentation": ":memo: Documentation",
47
- "internal": ":house: Internal"
48
- },
49
- "cacheDir": ".changelog"
50
- },
51
- "scripts": {
52
- "changelog": "lerna-changelog",
53
- "lint": "eslint lib --env mocha test",
54
- "clean": "rm -Rf ./coverage",
55
- "test": "npm run clean && istanbul cover ./node_modules/mocha/bin/_mocha --report none --print none --dir ./coverage/json -u exports -R test/*-test.js && istanbul report --root ./coverage/json html && istanbul report text-summary",
56
- "doc": "jsdoc -c .jsdoc.json"
57
- }
58
- }
@@ -1,16 +0,0 @@
1
-
2
- 1.0.2 / 2015-10-07
3
- ==================
4
-
5
- * use try/catch when checking `localStorage` (#3, @kumavis)
6
-
7
- 1.0.1 / 2014-11-25
8
- ==================
9
-
10
- * browser: use `console.warn()` for deprecation calls
11
- * browser: more jsdocs
12
-
13
- 1.0.0 / 2014-04-30
14
- ==================
15
-
16
- * initial commit
@@ -1,24 +0,0 @@
1
- (The MIT License)
2
-
3
- Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
4
-
5
- Permission is hereby granted, free of charge, to any person
6
- obtaining a copy of this software and associated documentation
7
- files (the "Software"), to deal in the Software without
8
- restriction, including without limitation the rights to use,
9
- copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- copies of the Software, and to permit persons to whom the
11
- Software is furnished to do so, subject to the following
12
- conditions:
13
-
14
- The above copyright notice and this permission notice shall be
15
- included in all copies or substantial portions of the Software.
16
-
17
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
19
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
21
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
22
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24
- OTHER DEALINGS IN THE SOFTWARE.
@@ -1,53 +0,0 @@
1
- util-deprecate
2
- ==============
3
- ### The Node.js `util.deprecate()` function with browser support
4
-
5
- In Node.js, this module simply re-exports the `util.deprecate()` function.
6
-
7
- In the web browser (i.e. via browserify), a browser-specific implementation
8
- of the `util.deprecate()` function is used.
9
-
10
-
11
- ## API
12
-
13
- A `deprecate()` function is the only thing exposed by this module.
14
-
15
- ``` javascript
16
- // setup:
17
- exports.foo = deprecate(foo, 'foo() is deprecated, use bar() instead');
18
-
19
-
20
- // users see:
21
- foo();
22
- // foo() is deprecated, use bar() instead
23
- foo();
24
- foo();
25
- ```
26
-
27
-
28
- ## License
29
-
30
- (The MIT License)
31
-
32
- Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
33
-
34
- Permission is hereby granted, free of charge, to any person
35
- obtaining a copy of this software and associated documentation
36
- files (the "Software"), to deal in the Software without
37
- restriction, including without limitation the rights to use,
38
- copy, modify, merge, publish, distribute, sublicense, and/or sell
39
- copies of the Software, and to permit persons to whom the
40
- Software is furnished to do so, subject to the following
41
- conditions:
42
-
43
- The above copyright notice and this permission notice shall be
44
- included in all copies or substantial portions of the Software.
45
-
46
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
47
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
48
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
49
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
50
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
51
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
52
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
53
- OTHER DEALINGS IN THE SOFTWARE.
@@ -1,67 +0,0 @@
1
-
2
- /**
3
- * Module exports.
4
- */
5
-
6
- module.exports = deprecate;
7
-
8
- /**
9
- * Mark that a method should not be used.
10
- * Returns a modified function which warns once by default.
11
- *
12
- * If `localStorage.noDeprecation = true` is set, then it is a no-op.
13
- *
14
- * If `localStorage.throwDeprecation = true` is set, then deprecated functions
15
- * will throw an Error when invoked.
16
- *
17
- * If `localStorage.traceDeprecation = true` is set, then deprecated functions
18
- * will invoke `console.trace()` instead of `console.error()`.
19
- *
20
- * @param {Function} fn - the function to deprecate
21
- * @param {String} msg - the string to print to the console when `fn` is invoked
22
- * @returns {Function} a new "deprecated" version of `fn`
23
- * @api public
24
- */
25
-
26
- function deprecate (fn, msg) {
27
- if (config('noDeprecation')) {
28
- return fn;
29
- }
30
-
31
- var warned = false;
32
- function deprecated() {
33
- if (!warned) {
34
- if (config('throwDeprecation')) {
35
- throw new Error(msg);
36
- } else if (config('traceDeprecation')) {
37
- console.trace(msg);
38
- } else {
39
- console.warn(msg);
40
- }
41
- warned = true;
42
- }
43
- return fn.apply(this, arguments);
44
- }
45
-
46
- return deprecated;
47
- }
48
-
49
- /**
50
- * Checks `localStorage` for boolean values for the given `name`.
51
- *
52
- * @param {String} name
53
- * @returns {Boolean}
54
- * @api private
55
- */
56
-
57
- function config (name) {
58
- // accessing global.localStorage can trigger a DOMException in sandboxed iframes
59
- try {
60
- if (!global.localStorage) return false;
61
- } catch (_) {
62
- return false;
63
- }
64
- var val = global.localStorage[name];
65
- if (null == val) return false;
66
- return String(val).toLowerCase() === 'true';
67
- }
@@ -1,6 +0,0 @@
1
-
2
- /**
3
- * For Node.js, simply re-export the core `util.deprecate` function.
4
- */
5
-
6
- module.exports = require('util').deprecate;
@@ -1,27 +0,0 @@
1
- {
2
- "name": "util-deprecate",
3
- "version": "1.0.2",
4
- "description": "The Node.js `util.deprecate()` function with browser support",
5
- "main": "node.js",
6
- "browser": "browser.js",
7
- "scripts": {
8
- "test": "echo \"Error: no test specified\" && exit 1"
9
- },
10
- "repository": {
11
- "type": "git",
12
- "url": "git://github.com/TooTallNate/util-deprecate.git"
13
- },
14
- "keywords": [
15
- "util",
16
- "deprecate",
17
- "browserify",
18
- "browser",
19
- "node"
20
- ],
21
- "author": "Nathan Rajlich <nathan@tootallnate.net> (http://n8.io/)",
22
- "license": "MIT",
23
- "bugs": {
24
- "url": "https://github.com/TooTallNate/util-deprecate/issues"
25
- },
26
- "homepage": "https://github.com/TooTallNate/util-deprecate"
27
- }
@@ -1,15 +0,0 @@
1
- The ISC License
2
-
3
- Copyright (c) Isaac Z. Schlueter and Contributors
4
-
5
- Permission to use, copy, modify, and/or distribute this software for any
6
- purpose with or without fee is hereby granted, provided that the above
7
- copyright notice and this permission notice appear in all copies.
8
-
9
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
15
- IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
@@ -1,36 +0,0 @@
1
- # wrappy
2
-
3
- Callback wrapping utility
4
-
5
- ## USAGE
6
-
7
- ```javascript
8
- var wrappy = require("wrappy")
9
-
10
- // var wrapper = wrappy(wrapperFunction)
11
-
12
- // make sure a cb is called only once
13
- // See also: http://npm.im/once for this specific use case
14
- var once = wrappy(function (cb) {
15
- var called = false
16
- return function () {
17
- if (called) return
18
- called = true
19
- return cb.apply(this, arguments)
20
- }
21
- })
22
-
23
- function printBoo () {
24
- console.log('boo')
25
- }
26
- // has some rando property
27
- printBoo.iAmBooPrinter = true
28
-
29
- var onlyPrintOnce = once(printBoo)
30
-
31
- onlyPrintOnce() // prints 'boo'
32
- onlyPrintOnce() // does nothing
33
-
34
- // random property is retained!
35
- assert.equal(onlyPrintOnce.iAmBooPrinter, true)
36
- ```
@@ -1,29 +0,0 @@
1
- {
2
- "name": "wrappy",
3
- "version": "1.0.2",
4
- "description": "Callback wrapping utility",
5
- "main": "wrappy.js",
6
- "files": [
7
- "wrappy.js"
8
- ],
9
- "directories": {
10
- "test": "test"
11
- },
12
- "dependencies": {},
13
- "devDependencies": {
14
- "tap": "^2.3.1"
15
- },
16
- "scripts": {
17
- "test": "tap --coverage test/*.js"
18
- },
19
- "repository": {
20
- "type": "git",
21
- "url": "https://github.com/npm/wrappy"
22
- },
23
- "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
24
- "license": "ISC",
25
- "bugs": {
26
- "url": "https://github.com/npm/wrappy/issues"
27
- },
28
- "homepage": "https://github.com/npm/wrappy"
29
- }
@@ -1,33 +0,0 @@
1
- // Returns a wrapper function that returns a wrapped callback
2
- // The wrapper function should do some stuff, and return a
3
- // presumably different callback function.
4
- // This makes sure that own properties are retained, so that
5
- // decorations and such are not lost along the way.
6
- module.exports = wrappy
7
- function wrappy (fn, cb) {
8
- if (fn && cb) return wrappy(fn)(cb)
9
-
10
- if (typeof fn !== 'function')
11
- throw new TypeError('need wrapper function')
12
-
13
- Object.keys(fn).forEach(function (k) {
14
- wrapper[k] = fn[k]
15
- })
16
-
17
- return wrapper
18
-
19
- function wrapper() {
20
- var args = new Array(arguments.length)
21
- for (var i = 0; i < args.length; i++) {
22
- args[i] = arguments[i]
23
- }
24
- var ret = fn.apply(this, args)
25
- var cb = args[args.length-1]
26
- if (typeof ret === 'function' && ret !== cb) {
27
- Object.keys(cb).forEach(function (k) {
28
- ret[k] = cb[k]
29
- })
30
- }
31
- return ret
32
- }
33
- }
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com>
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -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