圆顶- http- 类型

说明

HTTP 信件、 处理器和中间软件的脚本类型, 灵感来自 临 时 7, (中文(简体) ), 临 时 15 财务报告和审定财务报表 临 时 议 题。 。 。 .

仅合同:类型(加) pipe页:1 框架、路由器和中间软件取决于它和停留 可以互换,工厂和助手的任何执行都会创造和改变信息. 身体就是个 AsyncIterable<Uint8Array>,因此Node.js流和网络 ReadableStream不需要转换.

A, (中文(简体) ), I 财务报告和审定财务报表 O 扩展和默认为 Attributes (单位:千美元)Record<string, unknown>) (中文(简体) ).

所需资源

• 节点: 22

安装

穿过 国家预防机制 作为 @ hubbyts/ chubbyts- http- types。 。 。 .

npm i @chubbyts/chubbyts-http-types@^4.2.2

使用量

信件

import { Readable } from 'node:stream';
import type { ServerRequest } from '@chubbyts/chubbyts-http-types/message';

// GET https://user:password@localhost:10443/api?key1=value1&key2[]=value2&key3[key31]=value3#fragment
const request: ServerRequest = {
  method: 'GET',
  uri: {
    scheme: 'https',
    userInfo: 'user:password',
    host: 'localhost',
    port: 10443,
    path: '/api',
    query: 'key1=value1&key2[]=value2&key3[key31]=value3',
    fragment: 'fragment',
  },
  protocolVersion: '1.1',
  headers: { accept: ['application/json'] },
  body: Readable.from([]),
  signal: new AbortController().signal,
  attributes: {},
};

• method:已知方法自动完成,任何扩展方法(PROPFIND)被允许.
• uri.port数字 : undefined 没有明确的端口. uri.query:原始和百分比编码,无 ?。 。 。 .
• headers: 小写名称,每个都有一个数值列表.
• body:读取一次以延取(如. text(body) 从 node:stream/consumers,块是字节,从来没有 对象.
• signal: 当不再需要请求时中止(例如客户端断开). 服务器桥拥有它, 处理者传递,例如. fetch(url, { signal: request.signal })。 。 。 .
• attributes: 从请求中得出的值(路线参数,用户),参见 输入属性。 。 。 .

A 类 Request 没有 attributes页:1 Response 已经 status, (中文(简体) ), reasonPhrase, (中文(简体) ), protocolVersion, (中文(简体) ), headers 财务报告和审定财务报表 body。 。 。 .

工厂

创建信件有协议版本 1.1,没有头和一空的尸体。 每个请求都有自己的信号 (一个会把听众堆积在一起) Uri 用于当前,服务器请求启动时没有属性。 这个 理由短语回到 STATUS_CODES (如果未知则为空字符串).

帮助者

帮助者读取并更改消息和尿液,像PSR-7接口一样分出. 每一个执行都必须遵循 这些规则,所以中间器件工作 任何注射:

• 标题名称是大小写不敏感并存储的小写,名称必须是符号(RFC 9110 5.1),一个值必须 不包含 CR、 LF 或 NUL, 否则 with* 帮助者投掷
• 页:1 with* 帮助者返回新信件或 uri, 给定的信件保持不变
• 用嵌入式解析查询( n)key[sub]=value, (中文(简体) ), key[]=value和重复键入对象和数组, + 财务报告和审定财务报表 百分数编码解码, __proto__ 永远不要更改原型,限制(深度,阵列大小,参数)都在上升 执行进展情况
• 查询参数用索引键进行序列化(key[sub]=value, (中文(简体) ), key[0]=value),%编码(RFC 3986,空间为 %20),空阵列和对象被丢弃,所以重新解析它们返回
• 里端口为 undefined 如果它是其计划的标准之一(80对https, 443对https)

MessageHelpers (临7) MessageInterface:

RequestHelpers (临7) RequestInterface,包括: MessageHelpers数字 :

ServerRequestHelpers (临7) ServerRequestInterface,包括: RequestHelpers数字 :

(*) 名称仅在运行时知道(string),任何属性都可以被替换,因此其类型会被扩大以包括: 值的类型.

ResponseHelpers (临7) ResponseInterface,包括: MessageHelpers数字 :

UriHelpers (临7) UriInterface:

饼干帮手跟着 RFC 6265 (韩语) (PSR-7没有饼干支持):

• 一个名称必须是一个符号,一个值由 cookie-octets 组成,在双引号中可选,并且得到两个 编码或解码
• 路径和域不得包含 ; 或控制字符,无效 maxAge 或者说 expires 掷出
• sameSite: 'None' 财务报告和审定财务报表 partitioned 需求 secure页:1 __Secure- 前缀需要 secure页:1 __Host- 前缀 secure,路径 / 且无域
• 属性按顺序序列化 Path, (中文(简体) ), Domain, (中文(简体) ), Max-Age, (中文(简体) ), Expires, (中文(简体) ), Secure, (中文(简体) ), HttpOnly, (中文(简体) ), SameSite, (中文(简体) ), Partitioned
• withoutCookie 设置空值, Max-Age=0 还有一个 Expires 1970年,路径和领域必须匹配 饼干被设定

处理器

处理器将服务器请求转换为响应,其依赖性被注入:

import type { Handler } from '@chubbyts/chubbyts-http-types/handler';
import type { BodyFactory, ResponseFactory } from '@chubbyts/chubbyts-http-types/message-factory';
import type { ResponseHelpers } from '@chubbyts/chubbyts-http-types/message-helper';

export const createPingHandler = (
  responseFactory: ResponseFactory,
  bodyFactory: BodyFactory,
  responseHelpers: ResponseHelpers,
): Handler => {
  return async () => {
    const response = responseHelpers.withBody(
      responseFactory(200),
      bodyFactory(JSON.stringify({ datetime: new Date().toISOString() })),
    );

    return responseHelpers.withHeader(response, 'content-type', 'application/json');
  };
};

中间软件

中间软件在下一个处理器之前和之后更改请求,或者自行回复:

import type { Attributes } from '@chubbyts/chubbyts-http-types/message';
import type { ResponseHelpers, ServerRequestHelpers } from '@chubbyts/chubbyts-http-types/message-helper';
import type { Middleware } from '@chubbyts/chubbyts-http-types/middleware';

export const createRequestIdMiddleware = (
  serverRequestHelpers: ServerRequestHelpers,
  responseHelpers: ResponseHelpers,
): Middleware<Attributes, { requestId: string }> => {
  return async (request, handler) => {
    const requestId = crypto.randomUUID();

    const response = await handler(serverRequestHelpers.withAttribute(request, 'requestId', requestId));

    return responseHelpers.withHeader(response, 'x-request-id', requestId);
  };
};

管道

pipe 将中间软件编成一个,第一个是最外层:

import type { Handler } from '@chubbyts/chubbyts-http-types/handler';
import type { Middleware } from '@chubbyts/chubbyts-http-types/middleware';
import { pipe } from '@chubbyts/chubbyts-http-types/pipe';

declare const handler: Handler;
declare const middlewares: Array<Middleware>;

const middleware: Middleware = pipe(middlewares);

export const app: Handler = (request) => middleware(request, handler);

输入属性

依赖先前(由路由器或认证)设定的属性的处理器或中间软件宣布这些属性,即 添加属性声明它接收的属性和传递的属性为 Middleware<I, O>数字 :

import type { Handler } from '@chubbyts/chubbyts-http-types/handler';
import type { ResponseFactory } from '@chubbyts/chubbyts-http-types/message-factory';
import type { ResponseHelpers, ServerRequestHelpers } from '@chubbyts/chubbyts-http-types/message-helper';
import type { Middleware } from '@chubbyts/chubbyts-http-types/middleware';

type RequestIdAttributes = { requestId: string };
type UserAttributes = RequestIdAttributes & { userId: string };

export const createAuthenticationMiddleware = (
  serverRequestHelpers: ServerRequestHelpers,
  resolveUserId: (authorization: string) => Promise<string>,
): Middleware<RequestIdAttributes, UserAttributes> => {
  return async (request, handler) => {
    const userId = await resolveUserId(serverRequestHelpers.getHeaderLine(request, 'authorization'));

    return handler(serverRequestHelpers.withAttribute(request, 'userId', userId));
  };
};

export const createUserHandler =
  (responseFactory: ResponseFactory, responseHelpers: ResponseHelpers): Handler<UserAttributes> =>
  async (request) =>
    responseHelpers.withHeader(responseFactory(204), 'x-user-id', request.attributes.userId);

pipe 只编写共享相同属性的中间软件(Middleware<A>) (中文(简体) ). 与 m1: Middleware<RequestIdAttributes, UserAttributes> 财务报告和审定财务报表 m2: Middleware<UserAttributes, PingAttributes>, (中文(简体) ), pipe([m1, m2]) 编译为 a Middleware<UserAttributes>:它要求 userId 前面隐藏着 ping。 。 。 . 用手将这种中间软件链起来:

const app: Handler<RequestIdAttributes> = (request) => m1(request, (userRequest) => m2(userRequest, handler));

从3.x升级

版权

2026 道米尼克·佐格(英语: