mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
75563a29af
Although not clearly documented, the Socket object has a string 'id' attribute (see https://github.com/LearnBoost/socket.io/blob/master/lib/socket.js)
66 lines
1.9 KiB
TypeScript
66 lines
1.9 KiB
TypeScript
// Type definitions for socket.io
|
|
// Project: http://socket.io/
|
|
// Definitions by: William Orr <https://github.com/worr>
|
|
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
|
|
|
|
|
///<reference path='../node/node.d.ts' />
|
|
|
|
declare module "socket.io" {
|
|
import http = require('http');
|
|
|
|
export function listen(server: http.Server, options: any, fn: Function): SocketManager;
|
|
export function listen(server: http.Server, fn?: Function): SocketManager;
|
|
export function listen(port: Number): SocketManager;
|
|
}
|
|
|
|
interface Socket {
|
|
id: string;
|
|
json:any;
|
|
log: any;
|
|
volatile: any;
|
|
broadcast: any;
|
|
in(room: string): Socket;
|
|
to(room: string): Socket;
|
|
join(name: string, fn: Function): Socket;
|
|
unjoin(name: string, fn: Function): Socket;
|
|
set(key: string, value: any, fn: Function): Socket;
|
|
get(key: string, fn: Function): Socket;
|
|
has(key: string, fn: Function): Socket;
|
|
del(key: string, fn: Function): Socket;
|
|
disconnect(): Socket;
|
|
send(data: any, fn: Function): Socket;
|
|
emit(ev: any, ...data:any[]): Socket;
|
|
on(ns: string, fn: Function): Socket;
|
|
}
|
|
|
|
interface SocketNamespace {
|
|
clients(room: string): Socket[];
|
|
log: any;
|
|
store: any;
|
|
json: any;
|
|
volatile: any;
|
|
in(room: string): SocketNamespace;
|
|
on(evt: string, fn: (socket: Socket) => void): SocketNamespace;
|
|
to(room: string): SocketNamespace;
|
|
except(id: any): SocketNamespace;
|
|
send(data: any): any;
|
|
emit(ev: any, ...data:any[]): Socket;
|
|
socket(sid: any, readable: boolean): Socket;
|
|
authorization(fn: Function);
|
|
}
|
|
|
|
interface SocketManager {
|
|
get(key: any): any;
|
|
set(key: any, value: any): SocketManager;
|
|
enable(key: any): SocketManager;
|
|
disable(key: any): SocketManager;
|
|
enabled(key: any): boolean;
|
|
disabled(key: any): boolean;
|
|
configure(env: string, fn: Function): SocketManager;
|
|
configure(fn: Function): SocketManager;
|
|
of(nsp: string): SocketNamespace;
|
|
on(ns: string, fn: Function): SocketManager;
|
|
sockets: SocketNamespace;
|
|
}
|