vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-12 04:50:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added/Updated proxy /w docs

Browse Source
This commit is contained in:
Fredrik Høisæther Rasch
2015-09-21 12:13:22 +02:00
parent ebf3ac235c
commit 96f50990c8
1 changed files with 39 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
chrome/chrome.d.ts
Vendored
+39 -1
View File
@@ -5213,45 +5213,83 @@ declare module chrome.privacy {
////////////////////
// Proxy
////////////////////
/**
* Use the chrome.proxy API to manage Chrome's proxy settings. This API relies on the ChromeSetting prototype of the type API for getting and setting the proxy configuration.
* Permissions: "proxy"
* @since Chrome 13.
*/
declare module chrome.proxy {
/** An object holding proxy auto-config information. Exactly one of the fields should be non-empty. */
interface PacScript {
/** Optional. URL of the PAC file to be used. */
url?: string;
/** Optional. If true, an invalid PAC script will prevent the network stack from falling back to direct connections. Defaults to false. */
mandatory?: boolean;
/** Optional. A PAC script. */
data?: string;
}
/** An object encapsulating a complete proxy configuration. */
interface ProxyConfig {
/** Optional. The proxy rules describing this configuration. Use this for 'fixed_servers' mode. */
rules?: ProxyRules;
/** Optional. The proxy auto-config (PAC) script for this configuration. Use this for 'pac_script' mode. */
pacScript?: PacScript;
/**
* 'direct' = Never use a proxy
* 'auto_detect' = Auto detect proxy settings
* 'pac_script' = Use specified PAC script
* 'fixed_servers' = Manually specify proxy servers
* 'system' = Use system proxy settings
*/
mode: string;
}
/** An object encapsulating a single proxy server's specification. */
interface ProxyServer {
/** The URI of the proxy server. This must be an ASCII hostname (in Punycode format). IDNA is not supported, yet. */
host: string;
/** Optional. The scheme (protocol) of the proxy server itself. Defaults to 'http'. */
scheme?: string;
/** Optional. The port of the proxy server. Defaults to a port that depends on the scheme. */
port?: number;
}
/** An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'proxyForFtp' and 'fallbackProxy'. */
interface ProxyRules {
/** Optional. The proxy server to be used for FTP requests. */
proxyForFtp?: ProxyServer;
/** Optional. The proxy server to be used for HTTP requests. */
proxyForHttp?: ProxyServer;
facllbackProxy?: ProxyServer;
/** Optional. The proxy server to be used for everthing else or if any of the specific proxyFor... is not specified. */
fallbackProxy?: ProxyServer;
/** Optional. The proxy server to be used for all per-URL requests (that is http, https, and ftp). */
singleProxy?: ProxyServer;
/** Optional. The proxy server to be used for HTTPS requests. */
proxyForHttps?: ProxyServer;
/** Optional. List of servers to connect to without a proxy server. */
bypassList?: string[];
}
interface ErrorDetails {
/** Additional details about the error such as a JavaScript runtime error. */
details: string;
/** The error description. */
error: string;
/** If true, the error was fatal and the network transaction was aborted. Otherwise, a direct connection is used instead. */
fatal: boolean;
}
interface ProxyErrorEvent extends chrome.events.Event {
/**
* @param callback The callback parameter should be a function that looks like this:
* function(object details) {...};
*/
addListener(callback: (details: ErrorDetails) => void): void;
}
var settings: chrome.types.ChromeSetting;
/** Notifies about proxy errors. */
var onProxyError: ProxyErrorEvent;
}