@stomp/stompjs 7.0.0-beta1 → 7.0.0-beta3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -18
- package/bundles/package.json +6 -0
- package/bundles/stomp.umd.js +1728 -2044
- package/bundles/stomp.umd.js.map +1 -0
- package/bundles/stomp.umd.min.js +1 -1
- package/bundles/tcp-wrapper.cjs +84 -0
- package/bundles/tcp-wrapper.cjs.map +1 -0
- package/esm6/augment-websocket.d.ts +1 -1
- package/esm6/augment-websocket.js +1 -1
- package/esm6/augment-websocket.js.map +1 -1
- package/esm6/client.d.ts +51 -47
- package/esm6/client.js +160 -172
- package/esm6/client.js.map +1 -1
- package/esm6/compatibility/compat-client.d.ts +4 -4
- package/esm6/compatibility/compat-client.js +3 -3
- package/esm6/compatibility/compat-client.js.map +1 -1
- package/esm6/compatibility/heartbeat-info.d.ts +1 -1
- package/esm6/compatibility/stomp.d.ts +1 -1
- package/esm6/compatibility/stomp.js +2 -2
- package/esm6/compatibility/stomp.js.map +1 -1
- package/esm6/frame-impl.d.ts +3 -3
- package/esm6/frame-impl.js +1 -1
- package/esm6/frame-impl.js.map +1 -1
- package/esm6/i-frame.d.ts +1 -1
- package/esm6/i-message.d.ts +4 -4
- package/esm6/index-web.d.ts +13 -0
- package/esm6/index-web.js +15 -0
- package/esm6/index-web.js.map +1 -0
- package/esm6/index.d.ts +2 -13
- package/esm6/index.js +2 -14
- package/esm6/index.js.map +1 -1
- package/esm6/parser.d.ts +1 -1
- package/esm6/parser.js +3 -3
- package/esm6/parser.js.map +1 -1
- package/esm6/stomp-config.d.ts +4 -7
- package/esm6/stomp-config.js +0 -3
- package/esm6/stomp-config.js.map +1 -1
- package/esm6/stomp-handler.d.ts +6 -6
- package/esm6/stomp-handler.js +12 -12
- package/esm6/stomp-handler.js.map +1 -1
- package/esm6/stomp-subscription.d.ts +1 -1
- package/esm6/tcp-wrapper.d.ts +18 -0
- package/esm6/tcp-wrapper.js +61 -0
- package/esm6/tcp-wrapper.js.map +1 -0
- package/esm6/types.d.ts +14 -13
- package/esm6/types.js +2 -2
- package/esm6/types.js.map +1 -1
- package/esm6/versions.d.ts +3 -3
- package/esm6/versions.js +3 -3
- package/index.d.ts +1 -1
- package/package.json +11 -7
- package/src/augment-websocket.ts +1 -1
- package/src/client.ts +53 -49
- package/src/compatibility/compat-client.ts +5 -5
- package/src/compatibility/heartbeat-info.ts +1 -1
- package/src/compatibility/stomp.ts +3 -3
- package/src/frame-impl.ts +4 -4
- package/src/i-frame.ts +1 -1
- package/src/i-message.ts +4 -4
- package/src/index-web.ts +15 -0
- package/src/index.ts +2 -15
- package/src/parser.ts +4 -4
- package/src/stomp-config.ts +4 -7
- package/src/stomp-handler.ts +17 -17
- package/src/stomp-subscription.ts +1 -1
- package/src/tcp-wrapper.ts +83 -0
- package/src/types.ts +14 -13
- package/src/versions.ts +3 -3
package/README.md
CHANGED
|
@@ -1,43 +1,41 @@
|
|
|
1
1
|
# STOMP.js
|
|
2
2
|
|
|
3
|
-
[](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml)
|
|
4
|
+
[](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml)
|
|
5
|
+
[](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml)
|
|
6
|
+
[](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml)
|
|
4
7
|
|
|
5
8
|
This library provides a STOMP over WebSocket client for Web browser and node.js applications.
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
Please visit https://stomp-js.github.io/ for guides, FAQs and API docs.
|
|
8
11
|
|
|
9
|
-
|
|
10
|
-
Lower versions are not supported any longer.
|
|
12
|
+
# Introduction
|
|
11
13
|
|
|
12
14
|
This library allows you to connect to a STOMP broker over WebSocket. This library
|
|
13
15
|
supports complete STOMP specifications including all current protocol variants. Most
|
|
14
|
-
popular messaging brokers support STOMP and STOMP over WebSockets
|
|
16
|
+
popular messaging brokers support STOMP and STOMP over WebSockets out-of-the-box
|
|
15
17
|
or using plugins.
|
|
16
18
|
|
|
17
|
-
In general JavaScript engines in browsers are not friendly to binary protocols,
|
|
19
|
+
In general, JavaScript engines in browsers are not friendly to binary protocols,
|
|
18
20
|
so using STOMP is a good option because it is a text-oriented protocol.
|
|
19
21
|
|
|
20
22
|
This library has its roots in a version released by [Jeff Mesnil](http://jmesnil.net/).
|
|
21
23
|
|
|
22
24
|
## Current Status
|
|
23
25
|
|
|
24
|
-
Version 5 of this library has been bottom-up rewritten using TypeScript (versions 3/4
|
|
25
|
-
use CoffeeScript). The code has substantially changed, so, while there is a compatibility
|
|
26
|
-
mode, you might need to update your code.
|
|
27
|
-
|
|
28
26
|
This library is feature complete and has been used in production for many years. It
|
|
29
27
|
is actively maintained. You are welcome to file issues and submit pull requests.
|
|
30
28
|
|
|
31
29
|
## Getting started
|
|
32
30
|
|
|
33
|
-
The API documentation is hosted as GitHub pages for the
|
|
31
|
+
The API documentation is hosted as GitHub pages for the StompJS family of libraries.
|
|
34
32
|
You may head straight to the https://stomp-js.github.io/api-docs/latest/
|
|
35
33
|
|
|
36
34
|
This library comes with detailed usage instructions. Please find it at
|
|
37
35
|
[Usage instructions](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html).
|
|
38
36
|
Check out other guides at https://stomp-js.github.io/.
|
|
39
37
|
|
|
40
|
-
There
|
|
38
|
+
There is quite detailed API documentation,
|
|
41
39
|
you should start at https://stomp-js.github.io/api-docs/latest/classes/Client.html.
|
|
42
40
|
|
|
43
41
|
## Upgrading
|
|
@@ -51,14 +49,9 @@ to your code. Head to
|
|
|
51
49
|
https://github.com/stomp-js/rx-stomp is based on this library and exposes the entire functionality
|
|
52
50
|
offered by this library as RxJS Observables.
|
|
53
51
|
|
|
54
|
-
## Usage with Angular2+
|
|
55
|
-
|
|
56
|
-
https://github.com/stomp-js/ng2-stompjs is based on https://github.com/stomp-js/rx-stomp
|
|
57
|
-
and exposes key classes as Angular Injectable Services.
|
|
58
|
-
|
|
59
52
|
## TypeScript definitions
|
|
60
53
|
|
|
61
|
-
The npm package includes TypeScript definitions, so there is no need
|
|
54
|
+
The npm package includes TypeScript definitions, so there is no need to install it separately.
|
|
62
55
|
|
|
63
56
|
## Change-log
|
|
64
57
|
|