@hattip/compose
Hattip的中件系统.
compose
这个 compose 函数将多个处理器组成一个单一的,创建一个简单而强大的中间软件系统。 每个处理器被按顺序调用,直到有人返回一个响应. 一个操作员可以把控制权传给下一个操作员,要么不归还任何东西,要么打电话 context.next()。后者允许处理器在返回前修改响应。 手提器数组传递到 compose 被平整,并过滤出病态值.
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
处理器通过一个单一的参数,一个代表请求上下文的对象:
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>;
}