Merge pull request #1799 from ably/fix-modular-docs

Fix jsdocs for modular.d.ts
ably · Jun 20, 2024 · 2b24d21 · 2b24d21
2 parents b7e5156 + a065916
commit 2b24d21
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/modular.d.ts b/modular.d.ts
@@ -141,11 +141,11 @@ export declare const RealtimePresence: unknown;
  * const realtime = new BaseRealtime({ ...options, plugins: { WebSocketTransport, FetchRequest } });
  * ```
  *
- * Note that network conditions, such as firewalls or proxies, might prevent the client from establishing a WebSocket connection. For this reason, you may wish to provide the `BaseRealtime` instance with the ability to alternatively establish a connection using long polling which is less susceptible to these external conditions. You do this by passing in the {@link XHRPolling} module, alongside `WebSocketTransport`:
+ * Note that network conditions, such as firewalls or proxies, might prevent the client from establishing a WebSocket connection. For this reason, you may wish to provide the `BaseRealtime` instance with the ability to alternatively establish a connection using long polling which is less susceptible to these external conditions. You do this by passing in the {@link XHRPolling} plugin, alongside `WebSocketTransport`:
  *
  * ```javascript
- * import { BaseRealtime, WebSocketTransport, FetchRequest } from 'ably/modules';
- * const realtime = new BaseRealtime(options, { WebSocketTransport, XHRPolling, FetchRequest });
+ * import { BaseRealtime, WebSocketTransport, FetchRequest } from 'ably/modular';
+ * const realtime = new BaseRealtime({ ...options, plugins: { WebSocketTransport, XHRPolling, FetchRequest } });
  * ```
  */
 export declare const WebSocketTransport: unknown;