{"_id":"@agent-infra/browser-search","_rev":"14-83f14fd6ae3c62157eeacdd125a7bf11","name":"@agent-infra/browser-search","dist-tags":{"beta":"0.0.3-beta.3","latest":"0.0.5"},"versions":{"0.0.1":{"name":"@agent-infra/browser-search","version":"0.0.1","_id":"@agent-infra/browser-search@0.0.1","maintainers":[{"name":"ulivz","email":"472590061@qq.com"},{"name":"ycjcl868","email":"45808948@qq.com"}],"dist":{"shasum":"66cde896f59efe84fd07d704ee8639564a35282f","tarball":"https://registry.npmjs.org/@agent-infra/browser-search/-/browser-search-0.0.1.tgz","fileCount":57,"integrity":"sha512-YTYXInertXAj47vMztmyV3tMJXcOmjmMNuAPvdyQXEbjlgOPS2mzrEv6iedmW4HI1Nu8TvSSuru6ddB/S3pTPw==","signatures":[{"sig":"MEQCIAizqeZNPiwHilp1gfRebc75YFfSfTGgIRnCIFEiNSsvAiBuiKxPt3RvIOlMBeuaaI3OrkaHvHakk42frmDO1EIXVg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":141270},"main":"dist/index.js","_from":"file:agent-infra-browser-search-0.0.1.tgz","types":"dist/index.d.ts","module":"dist/index.mjs","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"scripts":{"dev":"rslib build --watch","test":"vitest run","build":"rslib build","coverage":"vitest run --coverage","test:e2e":"vitest --config vitest.e2e.config.ts","benchmark":"ts-node examples/benchmark.ts","test:watch":"vitest"},"_npmUser":{"name":"ycjcl868","email":"45808948@qq.com"},"_resolved":"/private/var/folders/l5/0qm3ztc10szdj2_h13k2l8800000gn/T/96650892f089c83637c9846233a77908/agent-infra-browser-search-0.0.1.tgz","_integrity":"sha512-YTYXInertXAj47vMztmyV3tMJXcOmjmMNuAPvdyQXEbjlgOPS2mzrEv6iedmW4HI1Nu8TvSSuru6ddB/S3pTPw==","_npmVersion":"10.8.1","description":"

\"npm \"npm \"npm \"npm \"npm \"npm \"npm \"npm \"npm \"npm \n \"npm\n \"downloads\"\n \"node\n \"license\"\n

\n\nEnglish | [įŽ€äŊ“中文](./README.zh-CN.md)\n\nA tiny stealth-mode web search and content extraction library built on top of Puppeteer, inspired by [EGOIST](https://github.com/egoist)'s [local-web-search](https://github.com/egoist/local-web-search).\n\n## Features\n\n- 🔍 **Multi-Engine Search** - Support for Google, Bing, and Baidu search engines\n- 📑 **Content Extraction** - Extract readable content from web pages using Readability\n- 🚀 **Concurrent Processing** - Built-in queue system for efficient parallel processing\n- 🛡ī¸ **Stealth Mode** - Advanced browser fingerprint spoofing\n- 📝 **Markdown Output** - Automatically converts HTML content to clean Markdown\n- ⚡ **Performance Optimized** - Smart request interception for faster page loads\n\n## Installation\n\n```bash\nnpm install @agent-infra/browser-search\n# or\nyarn add @agent-infra/browser-search\n# or\npnpm add @agent-infra/browser-search\n```\n\n## Quick Start\n\n```typescript\nimport { BrowserSearch } from '@agent-infra/browser-search';\nimport { ConsoleLogger } from '@agent-infra/logger';\n\n// Create a logger (optional)\nconst logger = new ConsoleLogger('[BrowserSearch]');\n\n// Initialize the search client\nconst browserSearch = new BrowserSearch({\n logger,\n browserOptions: {\n headless: true,\n },\n});\n\n// Perform a search\nconst results = await browserSearch.perform({\n query: 'climate change solutions',\n count: 5,\n});\n\nconsole.log(`Found ${results.length} results`);\nresults.forEach((result) => {\n console.log(`Title: ${result.title}`);\n console.log(`URL: ${result.url}`);\n console.log(`Content preview: ${result.content.substring(0, 150)}...`);\n});\n```\n\n## API Reference\n\n### BrowserSearch\n\n#### Constructor\n\n```typescript\nconstructor(config?: BrowserSearchConfig)\n```\n\nConfiguration options:\n\n```typescript\ninterface BrowserSearchConfig {\n logger?: Logger; // Custom logger\n browser?: BrowserInterface; // Custom browser instance\n}\n```\n\n#### perform(options)\n\nPerforms a search and extracts content from result pages.\n\n```typescript\nasync perform(options: BrowserSearchOptions): Promise\n```\n\nSearch options:\n\n```typescript\ninterface BrowserSearchOptions {\n query: string | string[]; // Search query or array of queries\n count?: number; // Maximum results to fetch\n concurrency?: number; // Concurrent requests (default: 15)\n excludeDomains?: string[]; // Domains to exclude\n truncate?: number; // Truncate content length\n browserOptions?: {\n headless?: boolean; // Run in headless mode\n proxy?: string; // Proxy server\n executablePath?: string; // Custom browser path\n profilePath?: string; // Browser profile path\n };\n}\n```\n\n#### Response Type\n\n```typescript\ninterface SearchResult {\n title: string; // Page title\n url: string; // Page URL\n content: string; // Extracted content in Markdown format\n}\n```\n\n## Advanced Usage\n\n### Multiple Queries\n\n```typescript\nconst results = await browserSearch.perform({\n query: ['renewable energy', 'solar power technology'],\n count: 10, // Will fetch approximately 5 results per query\n concurrency: 5,\n});\n```\n\n### Domain Exclusion\n\n```typescript\nconst results = await browserSearch.perform({\n query: 'artificial intelligence',\n excludeDomains: ['reddit.com', 'twitter.com', 'youtube.com'],\n count: 10,\n});\n```\n\n### Content Truncation\n\n```typescript\nconst results = await browserSearch.perform({\n query: 'machine learning',\n count: 5,\n truncate: 1000, // Limit content to 1000 characters\n});\n```\n\n### Using with Custom Browser Instance\n\n```typescript\nimport { ChromeBrowser } from '@agent-infra/browser';\nimport { BrowserSearch } from '@agent-infra/browser-search';\n\nconst browser = new ChromeBrowser({\n // Custom browser configuration\n});\n\nconst browserSearch = new BrowserSearch({\n browser,\n});\n\nconst results = await browserSearch.perform({\n query: 'typescript best practices',\n});\n```\n\n## Examples\n\nSee [examples](./examples/).\n\n\n## Credits\n\nThanks to:\n\n- [EGOIST](https://github.com/egoist) for creating a great AI chatbot product [ChatWise](https://chatwise.app/) from which we draw a lot of inspiration for local-browser based search.\n- The [puppeteer](https://github.com/puppeteer/puppeteer) project which helps us operate the browser better.\n\n## License\n\nCopyright (c) 2025 ByteDance, Inc. and its affiliates.\n\nLicensed under the Apache License, Version 2.0.\n","readmeFilename":"README.md"}