# @basenative/tenant 中文文档

规范地址：https://npmcn.com/package/%40basenative/tenant/

版本：3\.3\.0
npm 元数据更新时间：2026-11-03T01:38:30.168Z
中文译文更新时间：2026-11-08T08:46:10.436Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40basenative/tenant
原文对照：https://npmcn.com/package/%40basenative/tenant/?lang=original
项目主页：https://github.com/DuganLabs/BaseNative/tree/main/packages/tenant#readme
源码仓库：https://github.com/DuganLabs/BaseNative

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：16.6 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-03-20T05:27:52.354Z
- 最新版本发布：2026-11-03T01:38:29.785Z
- 近 30 天下载量：1846（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

具有子域/路径解析度和行级查询范围化的多租入中件

## 安装

```sh
npm install @basenative/tenant
```

也可以使用：`pnpm add @basenative/tenant`、`yarn add @basenative/tenant`、`bun add @basenative/tenant`

## README

# @ 低调/ 租户

> 带有子域、路径和页眉租户分辨率的多租户中间软件

部分 [基础](https://github.com/DuganLabs/basenative) 生态系统——一个基于信号的网络运行时间超过本土的HTML.

## 安装

```bash
npm install @basenative/tenant
```

## 快速启动

```js
import {
  createSubdomainResolver,
  tenantMiddleware,
  requireTenant,
  tenantScope,
} from '@basenative/tenant';
import { createPipeline } from '@basenative/middleware';

const pipeline = createPipeline()
  .use(tenantMiddleware(createSubdomainResolver({ baseDomain: 'example.com' })))
  .use(requireTenant())
  .use(async (ctx, next) => {
    // ctx.state.tenantId is now set
    console.log('Tenant:', ctx.state.tenantId);
    await next();
  });
```

## 解析器

```js
// Subdomain: acme.example.com -> "acme"
createSubdomainResolver({ baseDomain: 'example.com' });

// Path prefix: /t/acme/dashboard -> "acme"
createPathResolver({ prefix: '/t' });

// Request header: X-Tenant-ID: acme
createHeaderResolver({ header: 'x-tenant-id' });

// Try multiple resolvers in order
createCompositeResolver([subdomainResolver, headerResolver]);
```

## API 密码

### 解析器

-   `createSubdomainResolver(options?)` ——从子域取出租户. 选项 : `baseDomain`, (中文(简体) ), `exclude` (默认 : `['www']`) (中文(简体) ).
-   `createPathResolver(options?)` ——从URL路径前缀取出租户. 选项 : `prefix` (默认 : `'/t'`) (中文(简体) ).
-   `createHeaderResolver(options?)` ——从请求头取出租户. 选项 : `header`。 。 。 .
-   `createCompositeResolver(resolvers[])` ——按顺序对每个解析器进行调整并返回第一个非核结果.

### 中间软件

-   `tenantMiddleware(resolver)` ——运行每个请求的解析器并存储结果 `ctx.state.tenantId`。 。 。 .
-   `requireTenant(options?)` - 在下述情况下拒绝请求: `ctx.state.tenantId` 未设置。 选项 : `status` (默认:400), `message`。 。 。 .
-   `tenantScope(db, options?)` ——包装数据库适配器,以自动将租户范围范围输入查询. 选项 : `column` (默认 : `'tenant_id'`) (中文(简体) ).

## 许可证

阿帕奇 - 2.0

## 常见问题

### @basenative/tenant 是什么？

具有子域/路径解析度和行级查询范围化的多租入中件

### 如何安装 @basenative/tenant？

在项目目录运行 npm install @basenative/tenant，或使用 pnpm add / yarn add / bun add。

### @basenative/tenant 支持 TypeScript 吗？

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

### @basenative/tenant 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @basenative/tenant 可以商用吗？

@basenative/tenant 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @basenative/tenant 的下载量有多少？

根据 npm 官方下载统计，@basenative/tenant 在 2026/10/08 – 2026/11/06 这 30 天内被下载 1,846 次，日均约 62 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @basenative/tenant 还在维护吗？

最新版本 3\.3\.0 发布于 2026/11/03（5 天前）；至今共发布 14 个版本，其中过去 12 个月发布了 14 个；首次发布于 2026/03/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。