@haatlabs-core/provider-image-search

中文文档
0.18.5发布于 2026/11/14Apache-2.0TypeScriptESM + CJS近 30 天下载 4657

Image and web search through SearXNG, Brave or SerpApi behind one SearchProvider.

原始使用文档
文档目录8 节
  1. Install
  2. What it does
  3. Options
  4. Errors
  5. Gateway and deadlines
  6. Fixtures
  7. Testing
  8. Hosted services

@haatlabs-core/provider-image-search

@haatlabs-core/provider-image-search/contracts (0.12.1): IMAGE_SEARCH_ERRORS, SearchErrorCode, createSearchError and the SearchError type, with nothing of Node: a project's contracts, which its pages load, import from here and never the root, which is for Node.

Install

pnpm add @haatlabs-core/provider-image-search

What it does

Image search through SearXNG (directly or through a services gateway), Brave or SerpApi, and web-page search through SearXNG, behind one SearchProvider interface. createImageSearchProvider(config, deps) and createWebSearchProvider wrap the provider in the rate-limit gate, the circuit breaker and retry (protect, @haatlabs-core/providers), and with deps.cache in a cachedCall layer outside the gate, so a hit spends no token.

Options

config: provider ('searxng' | 'brave' | 'serpapi'), timeoutMs, and that provider's searxngBaseUrl and gatewayKey, braveApiKey or serpApiKey (named without its key, it fails at construction). deps: fetch, limiter and rateLimit (the gate), sleep, now, and cache ({ store, ttlMs, onEvent }; a null store computes every time). Each search takes SearchOptions: limit, safeSearch (0-2), language, signal, call.

Errors

SEARCH_PROVIDER_ERROR (503) with a message saying what failed: a 429, a 5xx, no answer, a time out and a body that is not JSON are transient (with retryAfterMs from Retry-After, seconds or a date, at most five minutes); a 401 or 403 is permanent, naming what to check; any other status is permanent. SerpApi's "Google hasn't returned any results" is no results; any other SerpApi error is a transient "SerpApi could not run the search", its text not passed on. A caller's abort is rethrown as theirs. A bad query or limit is the core VALIDATION_FAILED. A project spreads IMAGE_SEARCH_ERRORS into defineErrors.

Gateway and deadlines

call (tier, priority, deadlineMs) goes to the gateway with a gatewayKey, tier 4 in the background without one. Every provider's own time limit is timeoutMs, or call.deadlineMs when that is sooner (localTimeoutMs), and the gateway is given that limit, never longer. The deadline is each attempt's: a retry starts it again; pass signal for a hard limit on the whole search. Through the gateway a refusal carries an UpstreamStatusError as its cause: isGatewayRefusal(error) is true for the gateway's 401 and 403, and only its own bad_request 400 is a contract error.

With deps.cache, a search that finds the same search already running waits for its answer (cachedCall's single-flight), looking again for up to waitMs (10 s) before it searches itself. That wait does not end on the caller's signal: an aborted search answers once it is over, so waitMs bounds how late.

Fixtures

@haatlabs-core/provider-image-search/fixtures: searchFixtures.searxngImages is recorded from SearXNG; braveImages and serpApiImages are written in the shapes Brave and SerpApi document, not recorded, until the owner records them with a trial key.

Testing

pnpm --filter @haatlabs-core/provider-image-search test (unit, on the fixtures) and test:int (a real SearXNG in a container; needs Docker). The live tests, with the owner's BRAVE_API_KEY and SERPAPI_API_KEY, run with pnpm exec vitest run --config vitest.real.config.ts and are skipped without the keys.

Hosted services

Without a search engine of your own, provider: 'haatlabs' with haatlabsApiKey (your RapidAPI key) searches through the Haatlabs API on RapidAPI. A refusal is SEARCH_PROVIDER_ERROR, transient as the API's was, with the API's error (SERVICE_QUOTA_EXCEEDED, SERVICE_KEY_REFUSED, …) as its cause. See @haatlabs-core/services and https://haatlabs.shop/docs/services/

版本与发布记录

@haatlabs-core/provider-image-search 共发布 27 个版本,首次发布于 2026/10/23;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.18.5latest2026/11/144 天前
0.18.42026/11/134 天前
0.18.32026/11/134 天前
0.18.22026/11/134 天前
0.18.12026/11/134 天前
0.18.02026/11/134 天前

关于 @haatlabs-core/provider-image-search 的常见问题

@haatlabs-core/provider-image-search 是什么?

Image and web search through SearXNG, Brave or SerpApi behind one SearchProvider.

如何安装 @haatlabs-core/provider-image-search?

在项目目录运行 npm install @haatlabs-core/provider-image-search,或使用 pnpm add / yarn add / bun add。

@haatlabs-core/provider-image-search 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haatlabs-core/provider-image-search 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@haatlabs-core/provider-image-search 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haatlabs-core/provider-image-search 可以商用吗?

@haatlabs-core/provider-image-search 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@haatlabs-core/provider-image-search 的下载量有多少?

根据 npm 官方下载统计,@haatlabs-core/provider-image-search 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,657 次,日均约 155 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haatlabs-core/provider-image-search 还在维护吗?

最新版本 0.18.5 发布于 2026/11/14(4 天前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。