@mussnad/frappe-react-query
Version:
A React Query SDK for Frappe
31 lines (30 loc) • 1.07 kB
TypeScript
import { Socket } from 'socket.io-client';
import { TokenParams } from '.';
/** Socket class
* @param socket_port [Optional] socket port to connect to
* @param host [Optional] host to connect to
* @param port [Optional] port to connect to
* @param protocol [Optional] protocol to connect to
* @param url [Optional] url to connect to
* @param socket_port [Optional] socket port to connect to
*
* @returns socket object
*
* if url is not provided, it will be set to the current host and require socket_port
* if socket_port is not provided, it will be set to 9000
*/
export declare class SocketIO {
private socket_port;
private host;
private port;
private protocol;
private url;
socket: Socket;
/**
* @param url [Optional] url to connect to
* @param site_name [Optional] site name to connect to
* @param socket_port [Optional] socket port to connect to
* @param tokenParams [Optional] token parameters
*/
constructor(url?: string, site_name?: string, socket_port?: string, tokenParams?: TokenParams);
}