44[ ![ npm version] ( https://img.shields.io/npm/v/sockjs-client.svg?style=flat-square )] ( https://www.npmjs.com/package/sockjs-client ) [ ![ Build Status] ( https://img.shields.io/travis/sockjs/sockjs-client/master.svg?style=flat-square )] ( https://travis-ci.org/sockjs/sockjs-client ) [ ![ Dependencies] ( https://img.shields.io/david/sockjs/sockjs-client.svg?style=flat-square )] ( https://david-dm.org/sockjs/sockjs-client ) [ ![ Chat] ( https://img.shields.io/badge/Chat-gitter.im-blue.svg?style=flat-square )] ( https://gitter.im/sockjs/sockjs-client )
55[ ![ BrowserStack Status] ( https://www.browserstack.com/automate/badge.svg?badge_key=dW9YdlFsSEI5VzNBVVk5ZS9XT0xaTjJVQkhQMkRkNlZBQURiSWNWMC9jaz0tLXRJM05RbW1tTCt5TlhHaVgycFJUYmc9PQ==--e3ef9b9a9fa071084e6d87874b5fc65b71273821 )] ( https://www.browserstack.com/automate/public-build/dW9YdlFsSEI5VzNBVVk5ZS9XT0xaTjJVQkhQMkRkNlZBQURiSWNWMC9jaz0tLXRJM05RbW1tTCt5TlhHaVgycFJUYmc9PQ==--e3ef9b9a9fa071084e6d87874b5fc65b71273821 )
66
7+ # Supporting SockJS
8+
9+ Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.
10+
11+ [ Get supported sockjs-client with the Tidelift Subscription] ( https://tidelift.com/subscription/pkg/npm-sockjs-client?utm_source=npm-sockjs-client&utm_medium=referral&utm_campaign=readme )
12+
13+ # Summary
14+
715SockJS is a browser JavaScript library that provides a WebSocket-like
816object. SockJS gives you a coherent, cross-browser, Javascript API
917which creates a low latency, full duplex, cross-domain communication
@@ -48,7 +56,7 @@ Subscribe to
4856[ SockJS mailing list] ( https://groups.google.com/forum/#!forum/sockjs ) for
4957discussions and support.
5058
51- SockJS family:
59+ # SockJS family
5260
5361 * [ SockJS-client] ( https://github.com/sockjs/sockjs-client ) JavaScript client library
5462 * [ SockJS-node] ( https://github.com/sockjs/sockjs-node ) Node.js server
@@ -75,8 +83,7 @@ Work in progress:
7583 * [ SockJS-go] ( https://github.com/igm/sockjs-go/ )
7684 * [ syp.biz.SockJS.NET] ( https://github.com/sypbiz/SockJS.NET ) - .NET port of the SockJS client
7785
78- Getting Started
79- -------
86+ # Getting Started
8087
8188SockJS mimics the [ WebSockets API] ( https://www.w3.org/TR/websockets/ ) ,
8289but instead of ` WebSocket ` there is a ` SockJS ` Javascript object.
@@ -109,10 +116,9 @@ SockJS server. Here's a simple example:
109116
110117```
111118
112- SockJS-client API
113- -----------------
119+ # SockJS-client API
114120
115- ### SockJS class
121+ ## SockJS class
116122
117123Similar to the 'WebSocket' API, the 'SockJS' constructor takes one, or more arguments:
118124
@@ -162,8 +168,7 @@ bad practice. If you absolutely must do it, you can use
162168multiple subdomains, using a different subdomain for every
163169SockJS connection.
164170
165- Supported transports, by browser (html served from http:// or https://)
166- -----------------------------------------------------------------------
171+ # Supported transports, by browser (html served from http:// or https://)
167172
168173_ Browser_ | _ Websockets_ | _ Streaming_ | _ Polling_
169174----------------|------------------|-------------|-------------------
@@ -192,8 +197,7 @@ Konqueror | no | no | jsonp-polling
192197 Websockets "hixie-76". They can still be enabled by manually
193198 changing a browser setting.
194199
195- Supported transports, by browser (html served from file://)
196- -----------------------------------------------------------
200+ # Supported transports, by browser (html served from file://)
197201
198202Sometimes you may want to serve your html from "file://" address - for
199203development or if you're using PhoneGap or similar technologies. But
@@ -207,8 +211,7 @@ _Browser_ | _Websockets_ | _Streaming_ | _Polling_
207211IE 8, 9 | same as above | iframe-htmlfile | iframe-xhr-polling
208212Other | same as above | iframe-eventsource | iframe-xhr-polling
209213
210- Supported transports, by name
211- -----------------------------
214+ # Supported transports, by name
212215
213216_ Transport_ | _ References_
214217---------------------|---------------
@@ -239,8 +242,7 @@ jsonp-polling | Slow and old fashioned [JSONP polling][^6]. This transpor
239242[ ^ 10 ] : https://www.rfc-editor.org/rfc/rfc6455.txt
240243
241244
242- Connecting to SockJS without the client
243- ---------------------------------------
245+ # Connecting to SockJS without the client
244246
245247Although the main point of SockJS is to enable browser-to-server
246248connectivity, it is possible to connect to SockJS from an external
@@ -256,8 +258,7 @@ third party code or even a browser (though I don't know why you would
256258want to do so).
257259
258260
259- Deployment
260- ----------
261+ # Deployment
261262
262263You should use a version of sockjs-client
263264that supports the protocol used by your server. For example:
@@ -272,8 +273,7 @@ session stickiness, take a look at the
272273[ SockJS-node readme] ( https://github.com/sockjs/sockjs-node#readme ) .
273274
274275
275- Development and testing
276- -----------------------
276+ # Development and testing
277277
278278SockJS-client needs [ node.js] ( https://nodejs.org/ ) for running a test
279279server and JavaScript minification. If you want to work on
@@ -293,7 +293,7 @@ To generate minified JavaScript, run:
293293
294294Both commands output into the ` build ` directory.
295295
296- ### Testing
296+ ## Testing
297297
298298Automated testing provided by:
299299
@@ -306,8 +306,7 @@ pass all the tests.
306306
307307This will start [ karma] ( https://karma-runner.github.io ) and a test support server.
308308
309- Browser Quirks
310- --------------
309+ # Browser Quirks
311310
312311There are various browser quirks which we don't intend to address:
313312
0 commit comments