Skip to main content

Documentation Index

Fetch the complete documentation index at: https://wreq.sqdsh.win/llms.txt

Use this file to discover all available pages before exploring further.

​
What is a Transport?

A Transport is a reusable network context handle for transport level settings such as browser profile, OS emulation, proxy, and TLS verification options. Use it when you want reusable transport settings without creating a full session per proxy, for example when you keep one transport handle per proxy in a long running worker.

​
createTransport()

Create a reusable transport.

​
Signature

function createTransport(options?: CreateTransportOptions): Promise<Transport>

​
Options

​
proxy
string
Proxy URL for all requests made through this transport. Support depends on the native layer and proxy scheme.
​
browser
BrowserProfile
default:"chrome_142"
Browser fingerprint profile to use for this transport.
​
os
EmulationOS
default:"macos"
Operating system to emulate for this transport.
​
insecure
boolean
default:"false"
When true, accepts invalid/self-signed certificates. Use only if you understand the security tradeoffs.
​
poolIdleTimeout
number
Native transport idle timeout option (ms).
​
poolMaxIdlePerHost
number
Native transport per host idle connection limit option.
​
poolMaxSize
number
Native transport total connection limit option.
​
connectTimeout
number
TCP connect timeout (ms).
​
readTimeout
number
Read timeout (ms).
​
captureDiagnostics
boolean
default:"false"
Enable extra connection and TLS diagnostics for requests made through this transport by default.

​
Using a transport with fetch()

Pass the transport via RequestInit.transport. 
import { createTransport, fetch } from "wreq-js";

const transport = await createTransport({
  proxy: "http://user:pass@proxy.example.com:8080",
  browser: "chrome_142",
  poolMaxSize: 64,
});

try {
  const res = await fetch("https://httpbin.org/get", {
    transport,
    timeout: 10_000,
  });

  console.log(res.status);
} finally {
  await transport.close();
}
You can still pass per-request onRequestEvent callbacks when using a transport. If captureDiagnostics is enabled on the transport, returned responses expose response.diagnostics without having to repeat the flag on every request.

​
Important: request options that become invalid

When you provide transport, you must not also set browser, os, proxy, or insecure on that request. Those settings are owned by the transport. Create one transport per proxy, reuse it for all requests that should go through that proxy, and close transports when you no longer need them. 
import { createTransport, fetch, type Transport } from "wreq-js";

const transports = new Map<string, Transport>();

async function getTransportForProxy(proxy: string): Promise<Transport> {
  const cached = transports.get(proxy);
  if (cached && !cached.closed) return cached;

  const transport = await createTransport({ proxy, poolMaxSize: 32 });
  transports.set(proxy, transport);
  return transport;
}

export async function fetchViaProxy(url: string, proxy: string) {
  const transport = await getTransportForProxy(proxy);
  return fetch(url, { transport, timeout: 30_000 });
}

export async function shutdown() {
  await Promise.all([...transports.values()].map((t) => t.close()));
  transports.clear();
}

​
Transport lifecycle

​
transport.close()

Always close transports you create. 
await transport.close();
After closing, transport.closed becomes true and the transport can no longer be used. If you need separate cookie jars with shared transport settings (for example, multiple sessions through the same proxy), you can pass the same transport to multiple Session.fetch() calls.