@haatlabs-core/provider-background

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

Background removal through a rembg service.

原始使用文档
文档目录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-background

Install

pnpm add @haatlabs-core/provider-background

It leaves one package to your app, so the app holds one copy: sharp.

What it does

Background removal by a rembg service, called directly or through a services gateway. cutoutFromService(baseUrl, image, options) returns the cut-out (an RGBA PNG the size of the image); outlineFromService returns its alpha channel as a grey PNG. The image must be a WebP the caller made itself. Every answer is checked as a file from a stranger: a PNG by its bytes, with alpha, the size sent, at most 25 megapixels, at most 30 MiB. sharp is a peer: the app's own, with its settings, is the one used. The package leaves sharp's globals to the app; on a small host, call sharp.cache(false) and sharp.concurrency(1).

Options

model (BACKGROUND_MODEL, u2netp, by default), fetch, timeoutMs (10 s), maxReplyBytes (30 MiB), maxImageBytes (20 MiB, the gateway's own cap: a larger image is refused before any request, not transient), gatewayKey, call and signal.

Errors

BackgroundRemovalError(message, transient, { retryAfterMs?, cause? }). transient: the service is away, slow, busy or failing (a 429 or 5xx, no answer, a time out); otherwise the same image would get the same answer. A 429 or 5xx carries retryAfterMs from its Retry-After (seconds or a date, at most five minutes). The message never quotes the service. A caller's abort is rethrown as theirs.

Gateway and deadlines

With gatewayKey, call (tier, priority, deadlineMs) goes to the gateway, tier 4 in the background without one. The time limit is timeoutMs, or call.deadlineMs when that is sooner (localTimeoutMs; a deadline that is not a finite number is none), and the gateway is given that limit, never longer. The deadline is this call's: a caller's retry starts it again; pass signal for a hard limit. Through the gateway a refused status carries an UpstreamStatusError as its cause: isGatewayRefusal(error) is true for the gateway's 401 and 403.

Fixtures

@haatlabs-core/provider-background/fixtures: backgroundFixtures.image (an 8 x 6 WebP) and backgroundFixtures.cutout (the RGBA PNG answered for it, which passes every check). Made with sharp in the shape rembg answers, not recorded; each read is a fresh copy.

Testing

pnpm --filter @haatlabs-core/provider-background test: unit tests against a fake fetch.

Hosted services

Without a rembg service of your own, createBackgroundRemover({ mode: 'haatlabs', apiKey }) sends the image (at most 5 MB) to the Haatlabs API on RapidAPI and reads the signed cut-out it answers with: a PNG with an alpha channel, which may be smaller than the image when the API scaled a large one down. createBackgroundRemover({ mode: 'service', baseUrl, gatewayKey }) is cutoutFromService. See @haatlabs-core/services and https://haatlabs.shop/docs/services/

版本与发布记录

@haatlabs-core/provider-background 共发布 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-background 的常见问题

@haatlabs-core/provider-background 是什么?

Background removal through a rembg service.

如何安装 @haatlabs-core/provider-background?

在项目目录运行 npm install @haatlabs-core/provider-background,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:sharp(^0.35.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haatlabs-core/provider-background 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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

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

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