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.

​
Signature

function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>

​
Parameters

​
input
string | URL | Request
required
The resource to fetch. Can be a URL string, URL object, or a Request object.
​
init
RequestInit
Optional request configuration.

​
RequestInit options

​
method
string
default:"GET"
HTTP method: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS.
​
headers
HeadersInit
Request headers. Can be a Headers object, plain object, or array of key-value pairs.
​
body
BodyInit | null
Request body. Supported types: string, Buffer, URLSearchParams, ArrayBuffer, ArrayBufferView (for example Uint8Array), Blob, and FormData.
​
transport
Transport
Reusable transport context for this request (proxy + emulation settings, with connection behavior handled by the native layer). When provided, you must not also set browser, os, proxy, or insecure.
​
browser
BrowserProfile
Browser fingerprint profile to use (e.g., 'chrome_142', 'firefox_139').
​
os
EmulationOS
Operating system to emulate: 'windows', 'macos', 'linux', 'android', 'ios'.
​
proxy
string
Proxy URL. Support depends on the native layer and proxy scheme.
​
timeout
number
default:"30000"
Request timeout in milliseconds. Set to 0 to disable the timeout.
​
signal
AbortSignal
AbortSignal for cancelling the request.
​
redirect
'follow' | 'manual' | 'error'
default:"follow"
Redirect handling mode.
​
disableDefaultHeaders
boolean
default:"false"
When true, prevents browser emulation headers from being automatically added.
​
insecure
boolean
default:"false"
When true, accepts invalid/self-signed certificates. Use only in development.
​
onRequestEvent
(event: RequestEvent) => void
Optional callback for structured request lifecycle events emitted by the native layer. Use this to observe phases such as request start, response headers, and body download progress.
​
captureDiagnostics
boolean
default:"false"
When true, captures a final diagnostics payload on the response where supported by the native layer. This can include timing, address, and TLS peer details.

​
Response

Returns a Response object with:
  • status: HTTP status code
  • statusText: HTTP status text
  • headers: response headers
  • ok: true if status is 200-299
  • url: final URL after redirects
  • redirected: true if the response is the result of a redirect
  • body: ReadableStream<Uint8Array> or null
  • bodyUsed: true if body has been consumed
  • contentLength: content length from headers, or null
  • cookies: parsed response cookies as Record<string, string | string[]>
  • diagnostics: optional native diagnostics payload, or null

​
Response methods

  • json(): parse body as JSON
  • text(): get body as string
  • arrayBuffer(): get body as ArrayBuffer
  • blob(): get body as Blob
  • formData(): parse body as FormData
  • clone(): clone the response
See /concepts/compatibility-matrix for detailed compatibility notes and intentional deviations.

​
Request lifecycle events

When onRequestEvent is provided, fetch() emits structured events from the native bridge.
EventMeaning
request_startThe request has started in the native layer.
request_sentRequest headers/body have been handed off to the socket and the client is waiting for a response.
response_headersResponse headers have been received. Includes status and optional contentLength.
body_progressAdditional response body bytes were downloaded. Includes downloadedBytes and optional contentLength.
body_completeThe response body finished downloading.
doneThe native request lifecycle completed successfully.
errorThe native request lifecycle failed. Includes message when available.
Each event includes a timestamp, and some events include status, url, contentLength, downloadedBytes, or message. For a full worked example, see /guides/request-events.

​
Convenience helpers

import { get, post, request } from 'wreq-js';
  • get(url, init?) calls fetch(url, { ...init, method: "GET" }).
  • post(url, body?, init?) calls fetch(url, { ...init, method: "POST", body }).
  • request(options) is deprecated and kept for compatibility. Prefer fetch(url, init).

​
Examples

​
Basic GET request

import { fetch } from 'wreq-js';

const response = await fetch('https://api.example.com/data', {
  browser: 'chrome_142',
});

const data = await response.json();

​
POST with JSON body

const response = await fetch('https://api.example.com/submit', {
  method: 'POST',
  browser: 'chrome_142',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'John', email: 'john@example.com' }),
});

​
POST with form data

const response = await fetch('https://example.com/login', {
  method: 'POST',
  browser: 'chrome_142',
  body: new URLSearchParams({
    username: 'user',
    password: 'pass',
  }),
});

​
Observe request events and diagnostics

const response = await fetch('https://example.com/large-file', {
  browser: 'chrome_142',
  captureDiagnostics: true,
  onRequestEvent(event) {
    if (event.type === 'response_headers') {
      console.log('status:', event.status);
      console.log('content-length:', event.contentLength);
    }

    if (event.type === 'body_progress' && event.contentLength) {
      const pct = ((event.downloadedBytes ?? 0) / event.contentLength) * 100;
      console.log(`downloaded ${pct.toFixed(1)}%`);
    }
  },
});

console.log(response.diagnostics);

​
With timeout and abort

const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), 5000);

try {
  const response = await fetch('https://example.com/slow', {
    browser: 'chrome_142',
    timeout: 10000,
    signal: controller.signal,
  });
  console.log(await response.text());
} finally {
  clearTimeout(timeoutId);
}

​
Reuse connections via Transport

import { createTransport, fetch } from "wreq-js";

const transport = await createTransport({ proxy: "http://proxy.example.com:8080" });

try {
  const response = await fetch("https://example.com", { transport });
  console.log(await response.text());
} finally {
  await transport.close();
}

​
Custom headers without defaults

const response = await fetch('https://api.example.com', {
  browser: 'chrome_142',
  headers: {
    'User-Agent': 'MyBot/1.0',
    'Accept': 'application/json',
  },
  disableDefaultHeaders: true,
});