agent-base

Install

npm i agent-base

yarn add agent-base

pnpm add agent-base

Turn a function into an `http.Agent` instance

const INTERNAL: Symbol;

json: (stream: Readable) => Promise<any>;

req: (url: string | URL, opts?: https.RequestOptions) => ThenableRequest;

toBuffer: (stream: Readable) => Promise<Buffer>;

abstract class Agent extends http.Agent {}

constructor(opts?: http.AgentOptions);

defaultPort: number;

keepAlive: boolean;

options: Partial<any>;

protocol: string;

abstract connect: (
    req: http.ClientRequest,
    options: AgentConnectOpts
) => Promise<Duplex | http.Agent> | Duplex | http.Agent;

createConnection: () => Duplex;

createSocket: (
    req: http.ClientRequest,
    options: AgentConnectOpts,
    cb: (err: Error | null, s?: Duplex) => void
) => void;

getName: (options: AgentConnectOpts) => string;

isSecureEndpoint: (options?: AgentConnectOpts) => boolean;

type AgentConnectOpts = HttpConnectOpts | HttpsConnectOpts;

type ThenableRequest = http.ClientRequest & {
    then: Promise<http.IncomingMessage>['then'];
};

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/agent-base.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/agent-base)

HTML

<a href="https://www.jsdocs.io/package/agent-base"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>