@jeffusion / bungee-types

的类型定义 蹦极 —高性能的反向代理服务器。

安装

npm install @jeffusion/bungee-types
# or
bun add @jeffusion/bungee-types

使用

import type { AppConfig, RouteConfig } from '@jeffusion/bungee-types';

const config: AppConfig = {
  routes: [
    {
      path: '/api',
      endpoints: [
        { target: 'http://localhost:3000' }
      ]
    }
  ]
};

可用的类型

核心配置类型

• AppConfig -主应用程序配置
• RouteConfig -路由配置与上行和插件
• Endpoint -上游目标、权重、条件和方向规则

修改和插件类型

• ModificationRules —请求/响应修改规则
• PluginConfig -插件配置
• LoggingConfig -日志配置

类型的出口

根条目

import type { AppConfig } from '@jeffusion/bungee-types';

类型只出口

import type { RouteConfig } from '@jeffusion/bungee-types/types';

文档

有关存储聚合和运行时验证，请参见 配置引用。管理身份和代理密钥是插件功能；导出的TypeScript形状不会绕过配置验证。

插件运行时接口使用 @jeffusion/bungee-core/plugin不是这个包裹。

许可证

麻省理工学院