Merge pull request #8512 from bioball/xdomain

add xdomain typings
This commit is contained in:
Masahiro Wakame
2016-03-15 22:39:29 +09:00
2 changed files with 66 additions and 0 deletions

14
xdomain/xdomain-tests.ts Normal file
View File

@@ -0,0 +1,14 @@
/// <reference path="./xdomain.d.ts" />
xdomain.masters({
'http://abc.example.com': '/api/*'
});
xdomain.slaves({
"http://xyz.example.com": "/proxy.html"
});
xdomain.debug = true;
xdomain.on("log", (msg) => console.log(msg));
xdomain.on("timeout", () => console.log("timeout"));
xdomain.cookies.master = "MASTER";

52
xdomain/xdomain.d.ts vendored Normal file
View File

@@ -0,0 +1,52 @@
// Type definitions for xdomain v0.7.5
// Project: http://jpillora.com/xdomain/
// Definitions by: Dan Chao <http://dchao.co/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare interface XDomainCookies {
master: string;
slave: string;
}
declare interface IXDomain {
/**
* Will initialize as a master
*
* Each of the slaves must be defined as: origin: proxy file
*
* The slaves object is used as a list slaves to force one proxy file per origin.
* @param slaveObj
*/
slaves (slaveObj: Object): void;
/**
* Will initialize as a slave
*
* Each of the masters must be defined as: origin: path
*
* origin and path are converted to a regular expression by escaping all non-alphanumeric chars, then converting * into .* and finally wrapping it with ^ and $. path can also be a RegExp literal.
*
* Requests that do not match both the origin and the path regular expressions will be blocked.
* @param masterObj
*/
masters (masterObj: Object): void;
origin: string;
/**
* When true, XDomain will log actions to console
*/
debug: boolean;
/**
* event may be log, warn or timeout. When listening for log and warn events, handler with contain the message as
* the first parameter. The timeout event fires when an iframe exeeds the xdomain.timeout time limit.
* @param event
* @param handler
*/
on (event: "log"|"warn"|"timeout", handler: (message?: string) => any): void;
cookies: XDomainCookies;
}
declare var xdomain: IXDomain;
declare module "xdomain" {
export const xdomain: IXDomain;
}