Clémentine
init
7c5b7bd
|
raw
history blame
No virus
2.01 kB
# Installation
> `npm install --save @types/sockjs`
# Summary
This package contains type definitions for sockjs (https://github.com/sockjs/sockjs-node).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sockjs.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sockjs/index.d.ts)
````ts
/// <reference types="node" />
import http = require("http");
export interface ServerOptions {
sockjs_url?: string | undefined;
prefix?: string | undefined;
response_limit?: number | undefined;
websocket?: boolean | undefined;
jsessionid?: any;
log?(severity: string, message: string): void;
heartbeat_delay?: number | undefined;
disconnect_delay?: number | undefined;
}
export function createServer(options?: ServerOptions): Server;
export interface Server extends NodeJS.EventEmitter {
installHandlers(server: http.Server, options?: ServerOptions): any;
on(event: "connection", listener: (conn: Connection) => any): this;
on(event: string, listener: Function): this;
}
export interface Connection extends NodeJS.ReadWriteStream {
remoteAddress: string;
remotePort: number;
address: {
[key: string]: {
address: string;
port: number;
};
};
headers: {
[key: string]: string;
};
url: string;
pathname: string;
prefix: string;
protocol: string;
readyState: number;
id: string;
close(code?: string, reason?: string): boolean;
destroy(): void;
on(event: "data", listener: (message: string) => any): this;
on(event: "close", listener: () => void): this;
on(event: string, listener: Function): this;
}
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 15:11:36 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)
# Credits
These definitions were written by [Phil McCloghry-Laing](https://github.com/pmccloghrylaing).