68 lines
2.3 KiB
TypeScript
68 lines
2.3 KiB
TypeScript
import { CompatClient } from './compat-client';
|
|
/**
|
|
* STOMP Class, acts like a factory to create {@link Client}.
|
|
*
|
|
* Part of `@stomp/stompjs`.
|
|
*
|
|
* **Deprecated**
|
|
*
|
|
* It will be removed in next major version. Please switch to {@link Client}.
|
|
*/
|
|
export declare class Stomp {
|
|
/**
|
|
* In case you need to use a non standard class for WebSocket.
|
|
*
|
|
* For example when using within NodeJS environment:
|
|
*
|
|
* ```javascript
|
|
* StompJs = require('../../esm5/');
|
|
* Stomp = StompJs.Stomp;
|
|
* Stomp.WebSocketClass = require('websocket').w3cwebsocket;
|
|
* ```
|
|
*
|
|
* **Deprecated**
|
|
*
|
|
*
|
|
* It will be removed in next major version. Please switch to {@link Client}
|
|
* using [Client#webSocketFactory]{@link Client#webSocketFactory}.
|
|
*/
|
|
static WebSocketClass: any;
|
|
/**
|
|
* This method creates a WebSocket client that is connected to
|
|
* the STOMP server located at the url.
|
|
*
|
|
* ```javascript
|
|
* var url = "ws://localhost:61614/stomp";
|
|
* var client = Stomp.client(url);
|
|
* ```
|
|
*
|
|
* **Deprecated**
|
|
*
|
|
* It will be removed in next major version. Please switch to {@link Client}
|
|
* using [Client#brokerURL]{@link Client#brokerURL}.
|
|
*/
|
|
static client(url: string, protocols?: string[]): CompatClient;
|
|
/**
|
|
* This method is an alternative to [Stomp#client]{@link Stomp#client} to let the user
|
|
* specify the WebSocket to use (either a standard HTML5 WebSocket or
|
|
* a similar object).
|
|
*
|
|
* In order to support reconnection, the function Client._connect should be callable more than once.
|
|
* While reconnecting
|
|
* a new instance of underlying transport (TCP Socket, WebSocket or SockJS) will be needed. So, this function
|
|
* alternatively allows passing a function that should return a new instance of the underlying socket.
|
|
*
|
|
* ```javascript
|
|
* var client = Stomp.over(function(){
|
|
* return new WebSocket('ws://localhost:15674/ws')
|
|
* });
|
|
* ```
|
|
*
|
|
* **Deprecated**
|
|
*
|
|
* It will be removed in next major version. Please switch to {@link Client}
|
|
* using [Client#webSocketFactory]{@link Client#webSocketFactory}.
|
|
*/
|
|
static over(ws: any): CompatClient;
|
|
}
|