Cleanup and Grammar 02

kum-deepak · kum-deepak · commit 28c426c5a3a1 · 2023-01-10T07:02:40.000+05:30
diff --git a/_faqs/alternatives-are-there-any-missing-features-from-original-jeff-mesnil-stompjs.md b/_faqs/alternatives-are-there-any-missing-features-from-original-jeff-mesnil-stompjs.md
@@ -4,11 +4,11 @@ group: Jeff Mesnil's stompjs
 priority: ZAE
 ---
 
-The Jeff Mesnil's stompjs supports STOMP over TCP when used in NodeJS environment.
-Other than this, there are no known missing functionality.
+Jeff Mesnil's stompjs supports STOMP over TCP when used in the NodeJS environment.
+Other than this, there is no known missing functionality.
 If you intend to use this feature, please raise an issue.
 
-The Jeff Mesnil's stompjs does not support the STOMP protocol strictly
-while `@stomp/stompjs` implements the protocol strictly and completely.
+Jeff Mesnil's stompjs is not fully compliant to STOMP protocol.
+The `@stomp/stompjs` strictly adheres the protocol.
 This might, in some cases, give behavioral differences.
-If you facing any such issues please raise an issue.
+If you are facing any such issues, please raise an issue.
diff --git a/_faqs/alternatives-how-do-i-migrate-from-jeff-mesnil-s-stompjs.md b/_faqs/alternatives-how-do-i-migrate-from-jeff-mesnil-s-stompjs.md
@@ -7,9 +7,9 @@ priority: ZAC
 Please see [upgrading stompjs](/guide/stompjs/upgrading-stompjs.html)
 guide.
 
-API of v4 of this library is backwards compatible with original stompjs.
-In all likelihood your working code would work under compatibility mode of
-v5 of this library.
+The v4 of this library is backwards compatible with the original stompjs.
+In all likelihoods your working code would work under compatibility mode of
+v5.
 
-To use newer features like automatic reconnection, 100% compliance with STOMP
+To use newer features like automatic reconnection, compliance with STOMP
 standards, and binary payloads, you would need to upgrade to newer syntax.
diff --git a/_faqs/alternatives-how-is-it-related-to-stompjs-from-jeff-mesnil.md b/_faqs/alternatives-how-is-it-related-to-stompjs-from-jeff-mesnil.md
@@ -5,9 +5,9 @@ priority: ZAA
 ---
 
 [stompjs](https://www.npmjs.com/package/stompjs)
-from [Jeff Mesnil](http://jmesnil.net/) has been the most important
+from [Jeff Mesnil](http://jmesnil.net/) has been one of the initial
 STOMP implementations for JavaScript.
-However the original author has no longer been maintaining it since 2016.
+However, the original author has no longer been maintaining it since 2016.
 `@stomp/stompjs` started as a maintained fork.
 
 `@stomp/stompjs` v4 is an enhanced version of
diff --git a/_faqs/authentication-can-i-use-token-based-authentication-with-these-libraries.md b/_faqs/authentication-can-i-use-token-based-authentication-with-these-libraries.md
@@ -1,26 +1,26 @@
 ---
-question: 'Can I use Token based authentication with these libraries?'
+question: 'Can I use Token-based authentication with these libraries?'
 group: Authentication
 priority: GAA
 ---
 
 Even though [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
-is somewhat similar to HTTP(S), it differs in one very important aspect - it
+is somewhat similar to HTTP(S), it differs in one very important aspect — it
 does not allow control of headers.
 
-This poses a limitation on using token based authentication schemes using HTTP headers.
+This poses a limitation on using token-based authentication schemes using HTTP headers.
 
 Conventional brokers do not expect any authentication information as part of
 HTTP headers or HTTP connection parameters.
 These instead rely on STOMP protocol's
 [CONNECT Frame](https://stomp.github.io/stomp-specification-1.2.html#CONNECT_or_STOMP_Frame).
-This frame can have header key/value pairs.
+This frame can have headers as key/value pairs.
 You can control these by setting
 [connectHeaders](https://stomp-js.github.io/api-docs/latest/classes/Client.html#connectHeaders)
 configuration option.
-You can pass any pair of strings as key and values.
+You can pass any pair of strings as keys and values.
 
-So, typically for token based authentication you will pass the token as part of
+So, typically, for token-based authentication you will pass the token as part of
 [connectHeaders](https://stomp-js.github.io/api-docs/latest/classes/Client.html#connectHeaders).
 Check your broker documentation for details.
 
diff --git a/_faqs/authentication-my-authentication-tokens-expire-where-should-i-write-code-to-acquire-fresh-tokens.md b/_faqs/authentication-my-authentication-tokens-expire-where-should-i-write-code-to-acquire-fresh-tokens.md
@@ -9,7 +9,7 @@ The suggested place to acquire fresh tokens is
 callback.
 You can update the
 [connectHeaders](https://stomp-js.github.io/api-docs/latest/classes/Client.html#connectHeaders)
-after you have acquired fresh token.
+after you have acquired a fresh token.
 
 If you need to fetch a token using an async request (say using an XHR),
 you can set an async function as the callback.
diff --git a/_faqs/general-can-these-libraries-be-used-with-es6-or-typescript.md b/_faqs/general-can-these-libraries-be-used-with-es6-or-typescript.md
@@ -6,12 +6,10 @@ priority: ACC
 
 Yes.
 
-These libraries are released as [UMD](https://github.com/umdjs/umd).
-This should allow these modules to be used as JavaScript on web page as well as
-from variety of module systems.
+From 2023, these libraries are distributed as Javascript modules as default.
+These can be used with `import`.
 
 All these libraries have been developed in TypeScript and type definition
 files are included in releases.
 
-In the bundle, ESM5 and ESM6 variants are also included,
-which can be used as alternatives.
+In addition, a UMD bundle is included to be used as a html script tag.
diff --git a/_faqs/general-how-do-i-enable-logging.md b/_faqs/general-how-do-i-enable-logging.md
@@ -8,4 +8,4 @@ Please see [enabling debug log](/guide/stompjs/using-stompjs-v5.html#debug).
 
 The console debug output may have NULL characters, which will prevent it from copying and pasting
 into a GitHub issue.
-In such cases save it as a text file and attach with the issue.
+In such cases, save it as a text file and attach with the issue.
diff --git a/_faqs/general-polyfills-classes.md b/_faqs/general-polyfills-classes.md
@@ -4,4 +4,4 @@ group: General
 priority: AKA
 ---
 
-Please see [StompJs v5: Polyfills](/guide/stompjs/rx-stomp/ng2-stompjs/pollyfils-for-stompjs-v5.html)
+Please see [StompJs v5: Polyfills](/guide/stompjs/rx-stomp/polyfills-for-stompjs.html)
diff --git a/_faqs/general-polyfills-object-assign.md b/_faqs/general-polyfills-object-assign.md
diff --git a/_faqs/general-tree-shaking.md b/_faqs/general-tree-shaking.md
@@ -6,8 +6,4 @@ priority: ADM
 
 Yes.
 
-The versions, `stomp-js@6+` and `rx-stomp@1+` are distributed as `es2015` UMD and modules. These lead to small code size and proper tree shaking behavior.
-
-`rx-stomp`, before v1, was distributed as `commonjs` modules, which may not be tree shaking friendly. Please upgrade if you face issues.
-
-`ng2-stompjs` is likely to cause issues with newer Angular versions. So, please migrate to `rx-stomp`.
+Please update the latest versions before reporting any issues related to tree shaking.
diff --git a/_faqs/general-what-are-heartbeats-should-i-bother.md b/_faqs/general-what-are-heartbeats-should-i-bother.md
@@ -4,19 +4,20 @@ group: General
 priority: AEA
 ---
 
-Most of STOMP 1.1+ brokers will support heart beats.
-These can be broker to the client (incoming) or client to the broker (outgoing).
-When enabled periodic heat beats are sent.
-If heart beats are not received within specified time (along with some grace time),
+Most STOMP 1.1+ brokers will support heart beats.
+These can be from the broker to the client (incoming)
+or the client to the broker (outgoing).
+When enabled, periodic heartbeats are sent.
+If heartbeats are not received within specified time (along with some grace time),
 the connection is assumed to be stale and will be terminated.
 
 SockJS may not support heart beats.
-See [using STOMP with SockJS](/guide/stompjs/rx-stomp/ng2-stompjs/using-stomp-with-sockjs.html).
+See [using STOMP with SockJS](/guide/stompjs/rx-stomp/using-stomp-with-sockjs.html).
 
 Whether you should use heart beats is a complex decision.
-If you use it the disconnections will be detected sooner.
-However, it also means packets (actually a one byte payload) will keep getting sent/received even when
+If you use it, a stale connection will be detected sooner.
+However, it also means packets (actually a one-byte payload) will keep getting sent/received even when
 there is no application traffic.
 
-Please see [Heart Beats](/guide/stompjs/using-stompjs-v5.html#heart-beating)
-topic on how to use it.
+Please see the [Heart Beats](/guide/stompjs/using-stompjs-v5.html#heart-beating)
+topic for usage details.
diff --git a/_faqs/general-what-is-stomp.md b/_faqs/general-what-is-stomp.md
@@ -4,15 +4,15 @@ group: General
 priority: AAA
 ---
 
-[STOMP](https://stomp.github.io/index.html) is a very simple text protocol to
+[STOMP](https://stomp.github.io/index.html) is a simple text protocol to
 interact with messaging brokers.
-Typically one of [AMQP](https://www.amqp.org/),
+Usually, one of [AMQP](https://www.amqp.org/),
 [MQTT](http://mqtt.org/), [JMS](https://en.wikipedia.org/wiki/Java_Message_Service),
 or a similar protocol is used to connect to a messaging broker.
-In a language like JavaScript it may not be easy to implement any of these protocols.
+In a language like JavaScript, it may not be easy to implement any of these protocols.
 So, STOMP becomes a reasonable option.
 
-Further web browsers do not allow TCP connections from web pages.
-Thankfully these support [WebSockets](https://en.wikipedia.org/wiki/WebSocket).
-This library implements STOMP protocol over WebSockets, which is sometimes
-referred as WebStomp.
+In addition, web browsers do not allow TCP connections from web pages.
+To overcome this limitation, 
+most of the brokers support STOMP over [WebSockets](https://en.wikipedia.org/wiki/WebSocket).
+The STOMP over WebSockets is referred to as WebStomp.
diff --git a/_faqs/general-which-one-i-should-use-stompjs-rx-stomp-or-ng2-stompjs.md b/_faqs/general-which-one-i-should-use-stompjs-rx-stomp-or-ng2-stompjs.md
@@ -6,8 +6,22 @@ priority: ACA
 
 `stompjs` is the underlying core library, usable almost everywhere.
 
-`rx-stomp` exposes functionality as [RxJS] primitives. If you are already using RxJS in your project or are familiar with it, please consider using `rx-stomp`.
+`rx-stomp` exposes functionality as [RxJS] primitives.
+If you are already using RxJS in your project or are familiar with it, please consider using `rx-stomp`.
+
+Other than syntactical differences,
+these two variants have a very important difference.
+In `stompjs`, the [client] must only be used within the [onConnect] callback.
+Using it outside may produce strange errors.
+The `rx-stomp` does not suffer from this limitation.
+
+So, as a rule of thumb, if your application needs to use the [client] object
+outside the [onConnect] callback, use `rx-stomp`.
+
+When using with Angular, `rx-stomp` seems natual as 
+Angular relies heavily on [RxJS].
 
-Since Angular relies heavily on [RxJS], you should consider `rx-stomp` with Angular.
 
 [RxJS]: https://github.com/ReactiveX/RxJS
+[client]: /api-docs/latest/classes/Client.html
+[onConnect]: /api-docs/latest/classes/Client.html#onConnect
diff --git a/_faqs/nodejs-can-this-library-be-used-with-nodejs.md b/_faqs/nodejs-can-this-library-be-used-with-nodejs.md
@@ -4,9 +4,9 @@ group: NodeJS
 priority: GAA
 ---
 
-Yes, NodeJS is supported using WebSockets as communication mechanism.
+Yes, NodeJS is supported using WebSockets as the communication mechanism.
 Please see [NodeJS topic in using StompJS guide](/guide/stompjs/using-stompjs-v5.html#in-nodejs).
-In addition check the needed [PolyFills](/guide/stompjs/rx-stomp/ng2-stompjs/pollyfils-for-stompjs-v5.html#in-nodejs).
+In addition, check the needed [PolyFills](/guide/stompjs/rx-stomp/polyfills-for-stompjs.html).
 
 While this library can be used with NodeJS, if your broker supports,
 you should consider
diff --git a/_faqs/react-native-i-am-using-it-with-react-native-i-have-started-facing-strange-issues.md b/_faqs/react-native-i-am-using-it-with-react-native-i-have-started-facing-strange-issues.md
@@ -5,4 +5,4 @@ priority: XAA
 ---
 
 Please see
-[React Native - Additional Notes](/workaround/stompjs/rx-stomp/ng2-stompjs/react-native-additional-notes.html).
+[React Native - Additional Notes](/workaround/stompjs/rx-stomp/react-native-additional-notes.html).
diff --git a/_faqs/sockjs-i-am-using-sockjs-and-i-am-facing-issues-where-do-i-look.md b/_faqs/sockjs-i-am-using-sockjs-and-i-am-facing-issues-where-do-i-look.md
@@ -4,5 +4,5 @@ group: SockJS
 priority: EAE
 ---
 
-Several topics related to SockJS has been compiled at
-[Using STOMP with SockJS](/guide/stompjs/rx-stomp/ng2-stompjs/using-stomp-with-sockjs.html).
+Several topics related to SockJS have been compiled at
+[Using STOMP with SockJS](/guide/stompjs/rx-stomp/using-stomp-with-sockjs.html).
diff --git a/_faqs/sockjs-i-am-using-sockjs-my-automatic-reconnection-does-not-work.md b/_faqs/sockjs-i-am-using-sockjs-my-automatic-reconnection-does-not-work.md
@@ -7,7 +7,7 @@ priority: EAC
 You need to pass a factory that returns a SockJS instance.
 
 Please see
-[Using STOMP with SockJS](/guide/stompjs/rx-stomp/ng2-stompjs/using-stomp-with-sockjs.html)
+[Using STOMP with SockJS](/guide/stompjs/rx-stomp/using-stomp-with-sockjs.html)
 if you are using recent versions of these libraries.
 
 If you are using `Stomp.over` compatibility mode (or older version), please refer to
diff --git a/_faqs/sockjs-is-sockjs-needed-to-use-these-libraries.md b/_faqs/sockjs-is-sockjs-needed-to-use-these-libraries.md
@@ -8,4 +8,4 @@ No SockJS is not mandatory to use this library.
 
 SockJS, however, is supported.
 Please see
-[using StompJS with SockJS](/guide/stompjs/rx-stomp/ng2-stompjs/using-stomp-with-sockjs.html).
+[using StompJS with SockJS](/guide/stompjs/rx-stomp/using-stomp-with-sockjs.html).
diff --git a/_posts/2018-06-29-using-stompjs-v5.md b/_posts/2018-06-29-using-stompjs-v5.md
@@ -32,29 +32,13 @@ _Important: For NodeJS and React Native, please check [Polyfills]._
   - [https://cdn.jsdelivr.net/npm/@stomp/stompjs@5.0.0/bundles/stomp.umd.js](https://cdn.jsdelivr.net/npm/@stomp/stompjs@5.0.0/bundles/stomp.umd.js)
 - `StompJs` object will now be available. Read along to learn how to use it.
 
-### In NodeJS
-
-See [Polyfills & Critical Dependencies] for installing dependencies.
-
-```javascript
-// For StompJs >= 5.1.0
-StompJs = require('@stomp/stompjs');
-
-// For StompJs 5.0.x
-StompJs = require('@stomp/stompjs/esm5');
-```
-
-Read along to learn how to use the `StompJs` object.
-
-### TypeScript or ES6
-
-See [Polyfills & Critical Dependencies] for installing dependencies.
+### In NodeJS, TypeScript or ES6
 
 These libraries have been developed using typescript, and the typings are included in the distribution.
 
 You can import classes like the following:
 
-```typescript
+```javascript
 import { Client, Message } from '@stomp/stompjs';
 ```
 
@@ -166,8 +150,9 @@ destination and `callback`, a function with one message argument and an optional
 const subscription = client.subscribe('/queue/test', callback);
 ```
 
-The subscribe() method returns an object with one attribute, `id`,
-that correspond to the client subscription ID and one method `unsubscribe()` that can be used later on to unsubscribe the client from this destination.
+The `subscribe` method returns an object with one attribute, `id`,
+that correspond to the client subscription ID and one method `unsubscribe`
+that can be used later on to unsubscribe the client from this destination.
 
 Every time the broker sends a message to the client, the client will, in turn, invoke the callback with a [Message](/api-docs/latest/classes/Message.html) object.
 
@@ -182,7 +167,7 @@ callback = function (message) {
 };
 ```
 
-The `subscribe()` method takes an optional headers argument to specify additional `headers` when subscribing to a destination:
+The `subscribe` method takes an optional headers argument to specify additional `headers` when subscribing to a destination:
 
 ```javascript
 const headers = { ack: 'client' };
@@ -348,7 +333,7 @@ You can set the `reconnectDelay` to quite a small value.
 
 ## Debug
 
-On a busy system volume of logs can be overwhelming. Therefore, by default, the debug messages are ignored.
+On a busy system, the volume of logs can be overwhelming. Therefore, by default, the debug messages are ignored.
 
 [Client#debug](/api-docs/latest/classes/Client.html#debug) property can be set to a function (which will receive a `String` argument) to enable debug statements:
 
diff --git a/_posts/2018-09-08-upgrading-stompjs.md b/_posts/2018-09-08-upgrading-stompjs.md
diff --git a/index.md b/index.md
