58f8093689
- Updated all component headers and documentation
- Changed navbar and footer branding
- Updated homepage hero badge
- Modified page title in index.html
- Simplified footer text to 'Built with ❤️'
- Consistent V2 capitalization across all references
60 lines
2.3 KiB
TypeScript
60 lines
2.3 KiB
TypeScript
/// <reference types="node" />
|
|
import * as http from 'http';
|
|
import LRUCache from 'lru-cache';
|
|
import { Agent, AgentConnectOpts } from 'agent-base';
|
|
import { PacProxyAgentOptions } from 'pac-proxy-agent';
|
|
import { HttpProxyAgentOptions } from 'http-proxy-agent';
|
|
import { HttpsProxyAgentOptions } from 'https-proxy-agent';
|
|
import { SocksProxyAgentOptions } from 'socks-proxy-agent';
|
|
declare const PROTOCOLS: readonly ["http", "https", "socks", "socks4", "socks4a", "socks5", "socks5h", ...("pac+http" | "pac+https" | "pac+data" | "pac+file" | "pac+ftp")[]];
|
|
type ValidProtocol = (typeof PROTOCOLS)[number];
|
|
type AgentConstructor = new (...args: never[]) => Agent;
|
|
type GetProxyForUrlCallback = (url: string) => string;
|
|
/**
|
|
* Supported proxy types.
|
|
*/
|
|
export declare const proxies: {
|
|
[P in ValidProtocol]: [AgentConstructor, AgentConstructor];
|
|
};
|
|
export type ProxyAgentOptions = HttpProxyAgentOptions<''> & HttpsProxyAgentOptions<''> & SocksProxyAgentOptions & PacProxyAgentOptions<''> & {
|
|
/**
|
|
* Default `http.Agent` instance to use when no proxy is
|
|
* configured for a request. Defaults to a new `http.Agent()`
|
|
* instance with the proxy agent options passed in.
|
|
*/
|
|
httpAgent?: http.Agent;
|
|
/**
|
|
* Default `http.Agent` instance to use when no proxy is
|
|
* configured for a request. Defaults to a new `https.Agent()`
|
|
* instance with the proxy agent options passed in.
|
|
*/
|
|
httpsAgent?: http.Agent;
|
|
/**
|
|
* A callback for dynamic provision of proxy for url.
|
|
* Defaults to standard proxy environment variables,
|
|
* see https://www.npmjs.com/package/proxy-from-env for details
|
|
*/
|
|
getProxyForUrl?: GetProxyForUrlCallback;
|
|
};
|
|
/**
|
|
* Uses the appropriate `Agent` subclass based off of the "proxy"
|
|
* environment variables that are currently set.
|
|
*
|
|
* An LRU cache is used, to prevent unnecessary creation of proxy
|
|
* `http.Agent` instances.
|
|
*/
|
|
export declare class ProxyAgent extends Agent {
|
|
/**
|
|
* Cache for `Agent` instances.
|
|
*/
|
|
cache: LRUCache<string, Agent>;
|
|
connectOpts?: ProxyAgentOptions;
|
|
httpAgent: http.Agent;
|
|
httpsAgent: http.Agent;
|
|
getProxyForUrl: GetProxyForUrlCallback;
|
|
constructor(opts?: ProxyAgentOptions);
|
|
connect(req: http.ClientRequest, opts: AgentConnectOpts): Promise<http.Agent>;
|
|
destroy(): void;
|
|
}
|
|
export {};
|
|
//# sourceMappingURL=index.d.ts.map
|