@types/sockjs
- Version 0.3.36
- Published
- 5.35 kB
- 1 dependency
- MIT license
Install
npm i @types/sockjs
yarn add @types/sockjs
pnpm add @types/sockjs
Overview
TypeScript definitions for sockjs
Index
Functions
function createServer
createServer: (options?: ServerOptions) => Server;
Interfaces
interface Connection
interface Connection extends NodeJS.ReadWriteStream {}
property address
address: { [key: string]: { address: string; port: number; };};
property headers
headers: { [key: string]: string;};
property id
id: string;
property pathname
pathname: string;
property prefix
prefix: string;
property protocol
protocol: string;
property readyState
readyState: number;
property remoteAddress
remoteAddress: string;
property remotePort
remotePort: number;
property url
url: string;
method close
close: (code?: string, reason?: string) => boolean;
method destroy
destroy: () => void;
method on
on: { (event: 'data', listener: (message: string) => any): this; (event: 'close', listener: () => void): this; (event: string, listener: Function): this;};
interface Server
interface Server extends NodeJS.EventEmitter {}
method installHandlers
installHandlers: (server: http.Server, options?: ServerOptions) => any;
method on
on: { (event: 'connection', listener: (conn: Connection) => any): this; (event: string, listener: Function): this;};
interface ServerOptions
interface ServerOptions {}
property disconnect_delay
disconnect_delay?: number | undefined;
property heartbeat_delay
heartbeat_delay?: number | undefined;
property jsessionid
jsessionid?: any;
property prefix
prefix?: string | undefined;
property response_limit
response_limit?: number | undefined;
property sockjs_url
sockjs_url?: string | undefined;
property websocket
websocket?: boolean | undefined;
method log
log: (severity: string, message: string) => void;
Package Files (1)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/sockjs
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/sockjs)
- HTML<a href="https://www.jsdocs.io/package/@types/sockjs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3843 ms. - Missing or incorrect documentation? Open an issue for this package.