Add pusher-js

2026-08-11 12:30:18 +00:00 · 2015-09-19 15:52:50 +09:00
parent 6f6e5c7dd9
commit dbbafb3e72
2 changed files with 112 additions and 0 deletions
@@ -0,0 +1,5 @@
+/// <reference path="pusher-js.d.ts" />
+
+import js = require('pusher-js');
+
+//TODO
@@ -0,0 +1,107 @@
+// Type definitions for pusher-js
+// Project: https://github.com/pusher/pusher-js
+// Definitions by: Qubo <https://github.com/tkqubo>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "pusher-js" {
+
+    namespace pusher {
+        interface PusherConstructor {
+            (apiKey: string, config?: Config): Pusher;
+        	//TODO
+        }
+
+        interface Pusher {
+
+        }
+
+        interface Config {
+
+            /**
+             * Forces the connection to use encrypted transports.
+             */
+            encrypted?: boolean;
+
+            /**
+             * Endpoint on your server that will return the authentication signature needed for private channels.
+             */
+            authEndpoint?: string;
+
+            /**
+             * Defines how the authentication endpoint, defined using authEndpoint, will be called.
+             * There are two options available: ajax and jsonp.
+             */
+            authTransport?: string;
+
+            /**
+             * Allows passing additional data to authorizers. Supports query string params and headers (AJAX only).
+             * For example, following will pass foo=bar via the query string and baz: boo via headers:
+             */
+            auth?: AuthConfig;
+
+
+            /**
+             * Allows connecting to a different datacenter by setting up correct hostnames and ports for the connection.
+             */
+            cluster?: string;
+
+
+            /**
+             * Disables stats collection, so that connection metrics are not submitted to Pusher’s servers.
+             */
+            disableStats?: boolean;
+
+            /**
+             * Specifies which transports should be used by Pusher to establish a connection.
+             * Useful for applications running in controlled, well-behaving environments.
+             * Available transports: ws, wss, xhr_streaming, xhr_polling, sockjs.
+             * Additional transports may be added in the future and without adding them to this list, they will be disabled.
+             */
+            enabledTransports?: string[];
+
+
+            /**
+             * Specified which transports must not be used by Pusher to establish a connection.
+             * This settings overwrites transports whitelisted via the enabledTransports options.
+             * Available transports: ws, wss, xhr_streaming, xhr_polling, sockjs.
+             * Additional transports may be added in the future and without adding them to this list, they will be enabled.
+             */
+            disabledTransports?: string[];
+
+            /**
+             * Ignores null origin checks for HTTP fallbacks. Use with care, it should be disabled only if necessary (i.e. PhoneGap).
+             */
+            ignoreNullOrigin?: boolean;
+
+            /**
+             * After this time (in miliseconds) without any messages received from the server,
+             * a ping message will be sent to check if the connection is still working.
+             * Default value is is supplied by the server, low values will result in unnecessary traffic.
+             */
+            activityTimeout?: number;
+
+            /**
+             * Time before the connection is terminated after sending a ping message.
+             * Default is 30000 (30s). Low values will cause false disconnections, if latency is high.
+             */
+            pongTimeout?: number;
+
+            wsHost?: string;
+            wsPort?: number;
+            wssPort?: number;
+            httpHost?: string;
+            httpPort?: number;
+            httpsPort?: number;
+        }
+
+        interface AuthConfig {
+            params: { [key: string]: any };
+            headers: { [key: string]: any };
+        }
+    }
+
+    var pusher: pusher.PusherConstructor;
+
+    export = pusher;
+}
+