# @hattip/compose 中文文档

规范地址：https://npmcn.com/package/%40hattip/compose/

版本：0\.0\.49
npm 元数据更新时间：2024-11-03T17:29:54.487Z
中文译文更新时间：2026-11-17T14:28:49.298Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40hattip/compose
原文对照：https://npmcn.com/package/%40hattip/compose/?lang=original

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

- 包体积（解压后）：10.7 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2022-06-21T13:11:47.542Z
- 最新版本发布：2024-11-02T10:59:21.915Z
- 近 30 天下载量：4897（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：49（近 12 个月 0 个）

## 中文简介

Hattip 的中端软件系统

## 安装

```sh
npm install @hattip/compose
```

也可以使用：`pnpm add @hattip/compose`、`yarn add @hattip/compose`、`bun add @hattip/compose`

## README

# `@hattip/compose`

Hattip的中件系统.

## `compose`

这个 `compose` 函数将多个处理器组成一个单一的,创建一个简单而强大的中间软件系统。 每个处理器被按顺序调用,直到有人返回一个响应. 一个操作员可以把控制权传给下一个操作员,要么不归还任何东西,要么打电话 `context.next()`。后者允许处理器在返回前修改响应。 手提器数组传递到 `compose` 被平整,并过滤出病态值.

```js
import { compose } from "@hattip/compose";

// Example of making things available in `ctx`
// Middleware to parse the URL into a URL object
const urlParser = (ctx) => {
  ctx.url = new URL(ctx.request.url);
};

// Example of modifying the response
// Middleware to add an X-Powered-By header
const poweredBy = async (ctx) => {
  const response = await ctx.next();
  response.headers.set("X-Powered-By", "Hattip");
  return response;
};

const homeHandler = (ctx) => {
  if (ctx.url.pathname === "/") {
    return new Response("Home");
  }
};

const fooHandler = (ctx) => {
  if (ctx.url.pathname === "/foo") {
    return new Response("Foo");
  }
};

const barHandler = (ctx) => {
  if (ctx.url.pathname === "/bar") {
    return new Response("Bar");
  }
};

export default compose(
  urlParser,
  poweredBy,
  homeHandler,
  fooHandler,
  barHandler,
);
```

`compose` 结束处理器链, 最后处理器调用 `context.passThrough` 返回 404 个响应.

## 处理器

手递给 `compose` 可以返回或丢出一个 `Request` 对象或带有 a 的任何其他对象 `toResponse` 方法(反过来返回一个) `Response`同步或同步。 返回一个病态值会将控制权传递给下一个处理器。 通话 `context.next()` 操作相同但明确,并允许处理器在返回前修改响应.

## `RequestContext`

处理器通过一个单一的参数,一个代表请求上下文的对象:

```ts
interface RequestContext {
  /**
   * The request. @see https://developer.mozilla.org/en-US/docs/Web/API/Request
   */
  request: Request;
  /**
   * IP address that generated the request. Check with the platform adapter
   * documentation to understand how it is generated.
   */
  ip: string;
  /**
   * Platform specific stuff. Check with the platform adapter documentation for
   * more information.
   */
  platform: unknown;
  /**
   * Signal that the request hasn't been handled and the returned response is
   * a placeholder (usually a 404). In this case the adapter should handle the
   * request itself if it has a way to do that. For example, an Express
   * middleware adapter may call next() to let the next middleware handle the
   * request. An edge adapter may pass through the request to the origin
   * server. Other adapters may return the placeholder and ignore this call.
   */
  passThrough(): void;
  /**
   * Some platforms (e.g. Cloudflare Workers) require this to be called to
   * keep running after the response is returned when streaming responses.
   * This is a no-op if the platform adapter doesn't need to do anything.
   */
  waitUntil(promise: Promise<any>): void;
  /** Parsed request URL */
  url: URL;
  /** Request method */
  method: string;
  /** App-local stuff */
  locals: Locals;
  /** Call the next handler in the chain */
  next(): Promise<Response>;
  /** Redefine to handle errors by generating a response from an error */
  handleError(error: unknown): Response | Promise<Response>;
}
```

## 常见问题

### @hattip/compose 是什么？

Hattip 的中端软件系统

### 如何安装 @hattip/compose？

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

### @hattip/compose 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/hattip\_\_compose 是否存在。

### @hattip/compose 支持 ESM 还是 CommonJS？

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

### @hattip/compose 可以商用吗？

@hattip/compose 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @hattip/compose 的下载量有多少？

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

### @hattip/compose 还在维护吗？

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

