angular-signalr-hub.d.ts

// Type definitions for angular-signalr-hub v1.5.0
// Project: https://github.com/JustMaier/angular-signalr-hub
// Definitions by: Adam Santaniello <https://github.com/AdamSantaniello>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path='../signalr/signalr.d.ts' />

declare module ngSignalr {
    interface HubFactory {
        /**
         * Creates a new Hub connection
         */
        new(hubName: string, options: HubOptions) : Hub
    }
    
    class Hub {
        hubName: string;
        connection: SignalR;
        proxy: HubProxy;
        
        on(event: string, fn: (...args: any[]) => void): void;
        invoke(method: string, ...args: any[]): JQueryDeferred<any>;
        disconnect(): void;
        connect(): JQueryPromise<any>;
    }
    
    interface HubOptions {
        /**
         * Collection of client side callbacks
         */
        listeners?: { [index: string] : (...args: any[]) => void };
        
        /**
         * String array of server side methods which the client can call
         */
        methods?: Array<string>;
        
        /**
         * Sets the root path for the SignalR web service
         */
        rootPath?: string;
        
        /**
         * Object representing additional query params to be sent on connection
         */
        queryParams?: { [index: string] : string };
        
        /**
         * Function to handle hub connection errors
         */
        errorHandler?: (error: string) => void;
        
        /**
         * Enable/disable logging
         */
        logging?: boolean;
        
        /**
         * Use a shared global connection or create a new one just for this hub, defaults to true 
         */
        useSharedConnection?: boolean;
        
        /**
         * Sets transport method (e.g    'longPolling'    or    ['webSockets', 'longPolling'] )
         */
        transport?: any;
        
        /**
         * Function to handle hub connection state changed event
         */
        stateChanged?: (state: SignalRStateChange) => void;
    }
}