Merge branch 'master' into rename-repo-url

socket.io/socket.io.d.ts

@@ -16,21 +16,21 @@ interface SocketIOStatic {
 	 * Default Server constructor
 	 */
 	(): SocketIO.Server;
-	
+
 	/**
 	 * Creates a new Server
 	 * @param srv The HTTP server that we're going to bind to
 	 * @param opts An optional parameters object
 	 */
 	(srv: any, opts?: SocketIO.ServerOptions): SocketIO.Server;
-	
+
 	/**
 	 * Creates a new Server
 	 * @param port A port to bind to, as a number, or a string
 	 * @param An optional parameters object
 	 */
 	(port: string|number, opts?: SocketIO.ServerOptions): SocketIO.Server;
-	
+
 	/**
 	 * Creates a new Server
 	 * @param A parameters object
@@ -44,25 +44,25 @@ interface SocketIOStatic {
     listen: SocketIOStatic;
 }
 
-declare module SocketIO {
-	
+declare namespace SocketIO {
+
 	interface Server {
-		
+
 		/**
 		 * A dictionary of all the namespaces currently on this Server
 		 */
 		nsps: {[namespace: string]: Namespace};
-		
+
 		/**
 		 * The default '/' Namespace
 		 */
 		sockets: Namespace;
-		
+
 		/**
 		 * Sets the 'json' flag when emitting an event
 		 */
 		json: Server;
-		
+
 		/**
 		 * Server request verification function, that checks for allowed origins
 		 * @param req The http.IncomingMessage request
@@ -71,13 +71,13 @@ declare module SocketIO {
 		 * of type boolean
 		 */
 		checkRequest( req:any, fn:( err: any, success: boolean ) => void ):void;
-		
+
 		/**
 		 * Gets whether we're serving the client.js file or not
 		 * @default true
 		 */
 		serveClient(): boolean;
-		
+
 		/**
 		 * Sets whether we're serving the client.js file or not
 		 * @param v True if we want to serve the file, false otherwise
@@ -85,13 +85,13 @@ declare module SocketIO {
 		 * @return This Server
 		 */
 		serveClient( v: boolean ): Server;
-		
+
 		/**
 		 * Gets the client serving path
 		 * @default '/socket.io'
 		 */
 		path(): string;
-		
+
 		/**
 		 * Sets the client serving path
 		 * @param v The path to serve the client file on
@@ -99,13 +99,13 @@ declare module SocketIO {
 		 * @return This Server
 		 */
 		path( v: string ): Server;
-		
+
 		/**
 		 * Gets the adapter that we're going to use for handling rooms
 		 * @default typeof Adapter
 		 */
 		adapter(): any;
-		
+
 		/**
 		 * Sets the adapter (class) that we're going to use for handling rooms
 		 * @param v The class for the adapter to create
@@ -113,13 +113,13 @@ declare module SocketIO {
 		 * @return This Server
 		 */
 		adapter( v: any ): Server;
-		
+
 		/**
 		 * Gets the allowed origins for requests
 		 * @default "*:*"
 		 */
 		origins(): string;
-		
+
 		/**
 		 * Sets the allowed origins for requests
 		 * @param v The allowed origins, in host:port form
@@ -127,7 +127,7 @@ declare module SocketIO {
 		 * return This Server
 		 */
 		origins( v: string ): Server;
-		
+
 		/**
 		 * Attaches socket.io to a server
 		 * @param srv The http.Server that we want to attach to
@@ -135,7 +135,7 @@ declare module SocketIO {
 		 * @return This Server
 		 */
 		attach( srv: any, opts?: ServerOptions ): Server;
-		
+
 		/**
 		 * Attaches socket.io to a port
 		 * @param port The port that we want to attach to
@@ -143,31 +143,31 @@ declare module SocketIO {
 		 * @return This Server
 		 */
 		attach( port: number, opts?: ServerOptions ): Server;
-		
+
 		/**
 		 * @see attach( srv, opts )
 		 */
 		listen( srv: any, opts?: ServerOptions ): Server;
-		
+
 		/**
 		 * @see attach( port, opts )
 		 */
 		listen( port: number, opts?: ServerOptions ): Server;
-		
+
 		/**
 		 * Binds socket.io to an engine.io intsance
 		 * @param src The Engine.io (or compatible) server to bind to
 		 * @return This Server
 		 */
 		bind( srv: any ): Server;
-		
+
 		/**
 		 * Called with each incoming connection
 		 * @param socket The Engine.io Socket
 		 * @return This Server
 		 */
 		onconnection( socket: any ): Server;
-		
+
 		/**
 		 * Looks up/creates a Namespace
 		 * @param nsp The name of the NameSpace to look up/create. Should start
@@ -175,7 +175,7 @@ declare module SocketIO {
 		 * @return The Namespace
 		 */
 		of( nsp: string ): Namespace;
-		
+
 		/**
 		 * Closes the server connection
 		 */
@@ -188,12 +188,12 @@ declare module SocketIO {
 		 * @return The default '/' Namespace
 		 */
 		on( event: 'connection', listener: ( socket: Socket ) => void ): Namespace;
-		
+
 		/**
 		 * @see on( 'connection', listener )
 		 */
 		on( event: 'connect', listener: ( socket: Socket ) => void ): Namespace;
-		
+
 		/**
 		 * Base 'on' method to add a listener for an event
 		 * @param event The event that we want to add a listener for
@@ -202,19 +202,19 @@ declare module SocketIO {
 		 * @return The default '/' Namespace
 		 */
 		on( event: string, listener: Function ): Namespace;
-		
+
 		/**
 		 * Targets a room when emitting to the default '/' Namespace
-		 * @param room The name of the room that we're targeting 
+		 * @param room The name of the room that we're targeting
 		 * @return The default '/' Namespace
 		 */
 		to( room: string ): Namespace;
-		
+
 		/**
 		 * @see to( room )
 		 */
 		in( room: string ): Namespace;
-		
+
 		/**
 		 * Registers a middleware function, which is a function that gets executed
 		 * for every incoming Socket, on the default '/' Namespace
@@ -226,7 +226,7 @@ declare module SocketIO {
 		 * @return The default '/' Namespace
 		 */
 		use( fn: ( socket:Socket, fn: ( err?: any ) => void ) =>void ): Namespace;
-		
+
 		/**
 		 * Emits an event to the default Namespace
 		 * @param event The event that we want to emit
@@ -236,14 +236,14 @@ declare module SocketIO {
 		 * @return The default '/' Namespace
 		 */
 		emit( event: string, ...args: any[]): Namespace;
-		
+
 		/**
 		 * Sends a 'message' event
 		 * @see emit( event, ...args )
 		 * @return The default '/' Namespace
 		 */
 		send( ...args: any[] ): Namespace;
-		
+
 		/**
 		 * @see send( ...args )
 		 */
@@ -261,56 +261,56 @@ declare module SocketIO {
 		 */
 		compress( ...args: any[] ): Namespace;
 	}
-	
+
 	/**
 	 * Options to pass to our server when creating it
 	 */
 	interface ServerOptions {
-		
+
 		/**
 		 * The path to server the client file to
 		 * @default '/socket.io'
 		 */
 		path?: string;
-		
+
 		/**
 		 * Should we serve the client file?
 		 * @default true
 		 */
 		serveClient?: boolean;
-		
+
 		/**
 		 * The adapter to use for handling rooms. NOTE: this should be a class,
 		 * not an object
 		 * @default typeof Adapter
 		 */
 		adapter?: Adapter;
-		
+
 		/**
 		 * Accepted origins
 		 * @default '*:*'
 		 */
 		origins?: string;
-		
+
 		/**
 		 * How many milliseconds without a pong packed to consider the connection closed (engine.io)
 		 * @default 60000
 		 */
 		pingTimeout?: number;
-		
+
 		/**
 		 * How many milliseconds before sending a new ping packet (keep-alive) (engine.io)
 		 * @default 25000
 		 */
 		pingInterval?: number;
-		
+
 		/**
 		 * How many bytes or characters a message can be when polling, before closing the session
 		 * (to avoid Dos) (engine.io)
 		 * @default 10E7
 		 */
 		maxHttpBufferSize?: number;
-		
+
 		/**
 		 * A function that receives a given handshake or upgrade request as its first parameter,
 		 * and can decide whether to continue or not. The second argument is a function that needs
@@ -319,26 +319,26 @@ declare module SocketIO {
 		 * @default null
 		 */
 		allowRequest?: (request:any, callback: (err: number, success: boolean) => void) => void;
-		
+
 		/**
 		 * Transports to allow connections to (engine.io)
 		 * @default ['polling','websocket']
 		 */
 		transports?: string[];
-		
+
 		/**
 		 * Whether to allow transport upgrades (engine.io)
 		 * @default true
 		 */
 		allowUpgrades?: boolean;
-		
+
 		/**
 		 * parameters of the WebSocket permessage-deflate extension (see ws module).
 		 * Set to false to disable (engine.io)
 		 * @default true
 		 */
 		perMessageDeflate?: Object|boolean;
-		
+
 		/**
 		 * Parameters of the http compression for the polling transports (see zlib).
 		 * Set to false to disable, or set an object with parameter "threshold:number"
@@ -346,9 +346,9 @@ declare module SocketIO {
 		 * @default true|1024
 		 */
 		httpCompression?: Object|boolean;
-		
+
 		/**
-		 * Name of the HTTP cookie that contains the client sid to send as part of 
+		 * Name of the HTTP cookie that contains the client sid to send as part of
 		 * handshake response headers. Set to false to not send one (engine.io)
 		 * @default "io"
 		 */
@@ -360,39 +360,39 @@ declare module SocketIO {
 	 * to a Namespace requires a new Socket
 	 */
 	interface Namespace extends NodeJS.EventEmitter {
-		
+
 		/**
 		 * The name of the NameSpace
 		 */
 		name: string;
-		
+
 		/**
 		 * The controller Server for this Namespace
 		 */
 		server: Server;
-		
+
 		/**
 		 * A dictionary of all the Sockets connected to this Namespace, where
 		 * the Socket ID is the key
 		 */
 		sockets: { [id: string]: Socket };
-		
+
 		/**
 		 * A dictionary of all the Sockets connected to this Namespace, where
 		 * the Socket ID is the key
 		 */
 		connected: { [id: string]: Socket };
-		
+
 		/**
 		 * The Adapter that we're using to handle dealing with rooms etc
 		 */
 		adapter: Adapter;
-		
+
 		/**
 		 * Sets the 'json' flag when emitting an event
 		 */
 		json: Namespace;
-		
+
 		/**
 		 * Registers a middleware function, which is a function that gets executed
 		 * for every incoming Socket
@@ -404,26 +404,26 @@ declare module SocketIO {
 		 * @return This Namespace
 		 */
 		use( fn: ( socket:Socket, fn: ( err?: any ) => void ) =>void ): Namespace;
-		
+
 		/**
 		 * Targets a room when emitting
-		 * @param room The name of the room that we're targeting 
+		 * @param room The name of the room that we're targeting
 		 * @return This Namespace
 		 */
 		to( room: string ): Namespace;
-		
+
 		/**
 		 * @see to( room )
 		 */
 		in( room: string ): Namespace;
-		
+
 		/**
 		 * Sends a 'message' event
 		 * @see emit( event, ...args )
 		 * @return This Namespace
 		 */
 		send( ...args: any[] ): Namespace;
-		
+
 		/**
 		 * @see send( ...args )
 		 */
@@ -472,132 +472,132 @@ declare module SocketIO {
 	 * different return)
 	 */
 	interface Socket {
-		
+
 		/**
 		 * The namespace that this socket is for
 		 */
 		nsp: Namespace;
-		
+
 		/**
 		 * The Server that our namespace is in
 		 */
 		server: Server;
-		
+
 		/**
 		 * The Adapter that we use to handle our rooms
 		 */
 		adapter: Adapter;
-		
+
 		/**
 		 * The unique ID for this Socket. Regenerated at every connection. This is
 		 * also the name of the room that the Socket automatically joins on connection
 		 */
 		id: string;
-		
+
 		/**
-		 * The http.IncomingMessage request sent with the connection. Useful 
+		 * The http.IncomingMessage request sent with the connection. Useful
 		 * for recovering headers etc
 		 */
 		request: any;
-		
+
 		/**
 		 * The Client associated with this Socket
 		 */
 		client: Client;
-		
+
 		/**
 		 * The underlying Engine.io Socket instance
 		 */
 		conn: {
-		
+
 			/**
 			 * The ID for this socket - matches Client.id
 			 */
 			id: string;
-			
+
 			/**
 			 * The Engine.io Server for this socket
 			 */
 			server: any;
-			
+
 			/**
 			 * The ready state for the client. Either 'opening', 'open', 'closing', or 'closed'
 			 */
 			readyState: string;
-			
+
 			/**
 			 * The remote IP for this connection
 			 */
 			remoteAddress: string;
 		};
-		
+
 		/**
 		 * The list of rooms that this Socket is currently in, where
 		 * the ID the the room ID
 		 */
 		rooms: { [id: string]: string };
-		
+
 		/**
 		 * Is the Socket currently connected?
 		 */
 		connected: boolean;
-		
+
 		/**
 		 * Is the Socket currently disconnected?
 		 */
 		disconnected: boolean;
-		
+
 		/**
 		 * The object used when negociating the handshake
 		 */
 		handshake: {
 			/**
-			 * The headers passed along with the request. e.g. 'host', 
+			 * The headers passed along with the request. e.g. 'host',
 			 * 'connection', 'accept', 'referer', 'cookie'
 			 */
 			headers: any;
-			
+
 			/**
 			 * The current time, as a string
 			 */
 			time: string;
-			
+
 			/**
 			 * The remote address of the connection request
 			 */
 			address: string;
-			
+
 			/**
 			 * Is this a cross-domain request?
 			 */
 			xdomain: boolean;
-			
+
 			/**
 			 * Is this a secure request?
 			 */
 			secure: boolean;
-			
+
 			/**
 			 * The timestamp for when this was issued
 			 */
 			issued: number;
-			
+
 			/**
 			 * The request url
 			 */
 			url: string;
-			
+
 			/**
 			 * Any query string parameters in the request url
 			 */
 			query: any;
 		};
-		
+
 		/**
 		 * Sets the 'json' flag when emitting an event
 		 */
 		json: Socket;
-		
+
 		/**
 		 * Sets the 'volatile' flag when emitting an event. Volatile messages are
 		 * messages that can be dropped because of network issues and the like. Use
@@ -605,13 +605,13 @@ declare module SocketIO {
 		 * of them
 		 */
 		volatile: Socket;
-		
+
 		/**
 		 * Sets the 'broadcast' flag when emitting an event. Broadcasting an event
 		 * will send it to all the other sockets in the namespace except for yourself
 		 */
 		broadcast: Socket;
-		
+
 		/**
 		 * Emits an event to this client. If the 'broadcast' flag was set, this will
 		 * emit to all other clients, except for this one
@@ -622,30 +622,30 @@ declare module SocketIO {
 		 * @return This Socket
 		 */
 		emit( event: string, ...args: any[]): Socket;
-		
+
 		/**
 		 * Targets a room when broadcasting
 		 * @param room The name of the room that we're targeting
 		 * @return This Socket
 		 */
 		to( room: string ): Socket;
-		
+
 		/**
 		 * @see to( room )
 		 */
 		in( room: string ): Socket;
-		
+
 		/**
 		 * Sends a 'message' event
 		 * @see emit( event, ...args )
 		 */
 		send( ...args: any[] ): Socket;
-		
+
 		/**
 		 * @see send( ...args )
 		 */
 		write( ...args: any[] ): Socket;
-		
+
 		/**
 		 * Joins a room. You can join multiple rooms, and by default, on connection,
 		 * you join a room with the same name as your ID
@@ -655,7 +655,7 @@ declare module SocketIO {
 		 * @return This Socket
 		 */
 		join( name: string, fn?: ( err?: any ) => void ): Socket;
-		
+
 		/**
 		 * Leaves a room
 		 * @param name The name of the room to leave
@@ -663,34 +663,34 @@ declare module SocketIO {
 		 * take on optional parameter, err, of a possible error
 		 */
 		leave( name: string, fn?: Function ): Socket;
-		
+
 		/**
 		 * Leaves all the rooms that we've joined
 		 */
 		leaveAll(): void;
-		
+
 		/**
 		 * Disconnects this Socket
 		 * @param close If true, also closes the underlying connection
 		 * @return This Socket
 		 */
 		disconnect( close?: boolean ): Socket;
-		
+
 		/**
 		 * Adds a listener for a particular event. Calling multiple times will add
 		 * multiple listeners
 		 * @param event The event that we're listening for
-		 * @param fn The function to call when we get the event. Parameters depend on the 
+		 * @param fn The function to call when we get the event. Parameters depend on the
 		 * event in question
 		 * @return This Socket
 		 */
 		on( event: string, fn: Function ): Socket;
-		
+
 		/**
 		 * @see on( event, fn )
 		 */
 		addListener( event: string, fn: Function ): Socket;
-		
+
 		/**
 		 * Adds a listener for a particular event that will be invoked
 		 * a single time before being automatically removed
@@ -700,7 +700,7 @@ declare module SocketIO {
 		 * @return This Socket
 		 */
 		once( event: string, fn: Function ): Socket;
-		
+
 		/**
 		 * Removes a listener for a particular type of event. This will either
 		 * remove a specific listener, or all listeners for this type of event
@@ -709,20 +709,20 @@ declare module SocketIO {
 		 * @return This Socket
 		 */
 		removeListener( event: string, fn?: Function ): Socket;
-		
+
 		/**
 		 * Removes all event listeners on this object
 		 * @return This Socket
 		 */
 		removeAllListeners( event?: string ): Socket;
-		
+
 		/**
 		 * Sets the maximum number of listeners this instance can have
 		 * @param n The max number of listeners we can add to this emitter
 		 * @return This Socket
 		 */
 		setMaxListeners( n: number ): Socket;
-		
+
 		/**
 		 * Returns all the callbacks for a particular event
 		 * @param event The event that we're looking for the callbacks of
@@ -737,38 +737,38 @@ declare module SocketIO {
 		 */
 		compress( compress: boolean ): Socket;
 	}
-	
+
 	/**
 	 * The interface used when dealing with rooms etc
 	 */
 	interface Adapter extends NodeJS.EventEmitter {
-		
+
 		/**
 		 * The namespace that this adapter is for
 		 */
 		nsp: Namespace;
-		
+
 		/**
 		 * A dictionary of all the rooms that we have in this namespace
 		 * The rooms are made of a `sockets` key which is the dictionary of sockets per ID
 		 */
 		rooms: {[room: string]: {sockets: {[id: string]: boolean }}};
-		
+
 		/**
 		 * A dictionary of all the socket ids that we're dealing with, and all
 		 * the rooms that the socket is currently in
 		 */
 		sids: {[id: string]: {[room: string]: boolean}};
-		
+
 		/**
 		 * Adds a socket to a room. If the room doesn't exist, it's created
 		 * @param id The ID of the socket to add
 		 * @param room The name of the room to add the socket to
-		 * @param callback An optional callback to call when the socket has been 
+		 * @param callback An optional callback to call when the socket has been
 		 * added. It should take an optional parameter, error, if there was a problem
 		 */
 		add( id: string, room: string, callback?: ( err?: any ) => void ): void;
-		
+
 		/**
 		 * Removes a socket from a room. If there are no more sockets in the room,
 		 * the room is deleted
@@ -778,13 +778,13 @@ declare module SocketIO {
 		 * removed. It should take on optional parameter, error, if there was a problem
 		 */
 		del( id: string, room: string, callback?: ( err?: any ) => void ): void;
-		
+
 		/**
 		 * Removes a socket from all the rooms that it's joined
 		 * @param id The ID of the socket that we're removing
 		 */
 		delAll( id: string ):void;
-		
+
 		/**
 		 * Broadcasts a packet
 		 * @param packet The packet to broadcast
@@ -804,50 +804,50 @@ declare module SocketIO {
 		 * The Server that this client belongs to
 		 */
 		server: Server;
-		
+
 		/**
 		 * The underlying Engine.io Socket instance
 		 */
 		conn: {
-		
+
 			/**
 			 * The ID for this socket - matches Client.id
 			 */
 			id: string;
-			
+
 			/**
 			 * The Engine.io Server for this socket
 			 */
 			server: any;
-			
+
 			/**
 			 * The ready state for the client. Either 'opening', 'open', 'closing', or 'closed'
 			 */
 			readyState: string;
-			
+
 			/**
 			 * The remote IP for this connection
 			 */
 			remoteAddress: string;
 		};
-		
+
 		/**
 		 * The ID for this client. Regenerated at every connection
 		 */
 		id: string;
-		
+
 		/**
-		 * The http.IncomingMessage request sent with the connection. Useful 
+		 * The http.IncomingMessage request sent with the connection. Useful
 		 * for recovering headers etc
 		 */
 		request: any;
-		
+
 		/**
 		 * The dictionary of sockets currently connect via this client (i.e. to different
 		 * namespaces) where the Socket ID is the key
 		 */
 		sockets: {[id: string]: Socket};
-		
+
 		/**
 		 * A dictionary of all the namespaces for this client, with the Socket that
 		 * deals with that namespace