API Reference Overview

Complete API documentation for Reader

Main Exports

import {
  // Main API
  ReaderClient,
  scrape,
  crawl,

  // Types
  ScrapeOptions,
  ScrapeResult,
  CrawlOptions,
  CrawlResult,
  ProxyConfig,
  BrowserPoolConfig,

  // Error classes
  ReaderError,
  TimeoutError,
  NetworkError,
  CloudflareError,
  AccessDeniedError,
} from "@vakra-dev/reader";

Quick Reference

ReaderClient

The recommended way to use Reader. Manages browser lifecycle automatically.

const reader = new ReaderClient({ verbose: true });
const result = await reader.scrape({ urls: ["https://example.com"] });
await reader.close();

Full ReaderClient documentation →

scrape()

Scrape one or more URLs.

const result = await reader.scrape({
  urls: ["https://example.com"],
  formats: ["markdown"],
});

Full scrape() documentation →

crawl()

Crawl a website to discover pages.

const result = await reader.crawl({
  url: "https://example.com",
  depth: 2,
  maxPages: 50,
});

Full crawl() documentation →

Type Reference

Type	Description
ScrapeOptions	Options for scrape()
ScrapeResult	Result from scrape()
CrawlOptions	Options for crawl()
CrawlResult	Result from crawl()

Error Classes

All errors extend ReaderError with structured properties:

try {
  await reader.scrape({ urls: ["https://example.com"] });
} catch (error) {
  if (error instanceof ReaderError) {
    console.log(error.code); // Error code
    console.log(error.url); // URL that failed
    console.log(error.retryable); // Whether retry might help
    console.log(error.toJSON()); // Structured error data
  }
}

Error Class	Code	Description
TimeoutError	TIMEOUT	Request timed out
NetworkError	NETWORK_ERROR	Network failure
CloudflareError	CLOUDFLARE_BLOCKED	Challenge not resolved
AccessDeniedError	ACCESS_DENIED	403 or blocked
ValidationError	VALIDATION_ERROR	Invalid input
InvalidUrlError	INVALID_URL	Malformed URL
RobotsBlockedError	ROBOTS_BLOCKED	Blocked by robots.txt
BrowserPoolError	BROWSER_POOL_ERROR	Pool exhausted

Utility Exports

For advanced usage:

import {
  // Formatters
  formatToMarkdown,
  formatToHTML,

  // Content utilities
  extractMetadata,
  cleanContent,

  // URL utilities
  isValidUrl,
  validateUrls,
  resolveUrl,

  // Browser pool
  BrowserPool,
  HeroBrowserPool,

  // Cloudflare detection
  detectChallenge,
  waitForChallengeResolution,

  // Proxy utilities
  createProxyUrl,
  parseProxyUrl,
} from "@vakra-dev/reader";