让开源，少一点语言距离。
npm包中文文档

@devbie/newbie

中文文档
1.17.0发布于 2026/11/09MITTypeScriptCommonJS近 30 天下载 4498

新bie后端框架运行时间

中文使用文档
中文原文
文档目录10 节
  1. 特征
  2. 所需资源
  3. 安装
  4. 快开始
  5. 新 Factory 选项
  6. 什么框架线给你
  7. 列出终点和查询管道
  8. 环境变量
  9. 相关软件包
  10. 许可证

@devbie/ newbie (英语)

npm version license

包括电池在内的后端应用框架运行时间 雀巢号11, (中文(简体) ), 普里斯玛7 财务报告和审定财务报表 运通5纽比给你一个制作准备 单调的靴子- 安全中间器件、 验证、 光标 平滑管、分层例外过滤链、扩展的Prisma接入和 可选的自我报告——不强迫你把它全部接通.

特征

  • 单打靴子 —— 说 NewbieFactory.create() 配置 CORS, cookie 解析、体解析、全球 ValidationPipe外壳(生产)和 Swagger(开发),然后启动HTTP服务器.
  • 全球框架单元 —— 说 FrameworkModule.forRoot() 安装配置 装入,限制速率, HttpModule,一个统一的响应拦截器和一个 五层例外过滤链.
  • 扩展 Prisma 集成 - 提供您生成的 PrismaClient 财务报告和审定财务报表 获得全局 PrismaService 支持已注册的客户端扩展 模块初始化后.
  • 查询参数管 - 光标指针、光标弹、命令和 select编号 :include编号 :where 解析 Prisma 驱动的列表终点 .
  • 共享的DTO和公用事业 - 请求/答复DTO和密码, 日期时间、阵列和其他常见帮助者.
  • 建造的可观察性 ——有限度要求的优雅停产 排水、观察-模式端口-跟踪恢复和内置后端显示器 探测器BACKEND_MONITOR_ENDPOINT + 键 BACKEND_MONITOR_TOKEN和 模块组合报告员(MODULE_HUB_ENDPOINT + 键 MODULE_HUB_TOKEN) (中文(简体) ).

所需资源

@devbie/newbie 是运行时库; NestJS, Prisma 和相关软件包是 声明为对等依赖, 因此您的工程控制其版本 :

同伴依赖关系版本
@nestjs/common^11.0.0
@nestjs/core^11.0.0
@nestjs/platform-express^11.0.0
@nestjs/config^4.0.0
@nestjs/swagger^11.0.0
@nestjs/throttler^6.0.0
@nestjs/axios^4.0.0
@prisma/client^7.0.0
@prisma/adapter-pg^7.0.0
express^5.0.0

安装

npm install @devbie/newbie

快开始

登记册 FrameworkModule.forRoot() 在你的根模块中,并通过您的 生成 PrismaClient 构造器 :

// src/application/application.module.ts
import { Module } from "@nestjs/common";
import { FrameworkModule } from "@devbie/newbie";
import { PrismaClient } from "@generated/prisma/client";
import { ApplicationController } from "./application.controller";

@Module({
  imports: [FrameworkModule.forRoot({ prisma: { PrismaClient } })],
  controllers: [ApplicationController],
})
export class ApplicationModule {}

然后带靴子 NewbieFactory数字 :

// src/main.ts
import { NewbieFactory } from "@devbie/newbie";
import { ApplicationModule } from "./application/application.module";

async function bootstrap(): Promise<void> {
  await NewbieFactory.create(ApplicationModule, {
    swagger: { title: "My API" },
  });
}

void bootstrap();

获得这个结构的最快方法 就是用脚手架安装一个项目 伴侣 CLI :

npx @devbie/newbie-cli create my-app

新 Factory 选项

NewbieFactory.create(rootModule, options) 接受以下选项 (每个领域都是可选的):

选项类型默认说明
environmentstringENVIRONMENT 或者说 developmentdevelopment 允许斯瓦格; production 允许头盔.
portnumberPORT 或者说 3000打开 HTTP 服务器.
corsAllowedOriginsstring[]ALLOWED_ORIGINS允许 CORS 源( 证书启用) .
bodyLimitstring10mb最大请求体型 .
requestTimeoutnumber60000请求超时, 以毫秒计 .
keepAliveTimeoutnumber—— 说保持超时 毫秒.
loggerstring[]LOG_LEVEL 或者说 ['log','warn','error']NestJS日志级别.
swaggerobject | false已启用的开发斯瓦格配置( S)title, (中文(简体) ), description, (中文(简体) ), version, (中文(简体) ), path,默认路径 /api) (中文(简体) ).
portRaceRecoverybooleanenvironment !== "production"在比赛期间幸存的港口比赛 nest start --watch {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}在捆绑地上.
shutdownTimeoutMsnumber10000SIGTERM/SIGINT的飞行请求的宽限期.
clusterbooleanfalse每个可用的CPU核心运行一个工人.

什么框架线给你

  • cookie-parserJSON/URL编码机身解析器,并总是 text/plain 解析( SDKs 监视器报告通过 navigator.sendBeacon) (中文(简体) ).
  • 具有证书的 CORS, 加上 v4 (扩展) Express 查询解析器 。 路线 装饰 @AllowAnyOrigin() 回复 Access-Control-Allow-Origin: * (包括飞行前),而所有其他路线则保留原产地白名单.
  • 全球 ValidationPipe 与 transform 财务报告和审定财务报表 whitelist 启用 .
  • 生产中的头盔; 开发中的Swagger UI(cookie +无记名认证).
  • 全球节流器守护( 默认情况下每端点有1,000个请求 / 第二个请求) .
  • 反应形状 HttpResponseInterceptor。 。 。 .
  • 例外过滤器按优先顺序排列: 节流器 → Prisma → 新起子 → HTTP → 包罗万象,所以每一次失败都有一个一致的错误信封.
  • 收听后的内幕记者:心跳(HEARTBEAT_*页:1 (单位:千美元)MODULE_HUB_*)和依赖性健康(HEALTH_*; 检查总是运行 POST 在端点未设置时被跳过 .

列出终点和查询管道

将查询参数翻译为 Prisma 参数的新船管:

  • WherePipe - 分析a where 查询参数进入 Prisma 过滤器.
  • OrderByPipe ——解析顺序参数.
  • SelectIncludePipe - 剖析 select 编号 : include 参数.
  • CursorPipe 编号 : CursorSlugPipe ——按键集(cursor)发卡参数.

共用的DTO(CommonListRequestDto, (中文(简体) ), CommonListResponseDto, (中文(简体) ), CommonGetByStringIdRequestDto, (中文(简体) ), CommonGetByNumberIdRequestDto保存列表 各个模块的终点一致。 这个 @Cookies() 参数装饰器 提供对请求 cookie 的打入.

环境变量

变量用于
ENVIRONMENTdevelopment 或者说 production。 。 。 .
PORTHTTP 听端口.
ALLOWED_ORIGINS逗号分离的 CORS 源列表 .
LOG_LEVEL以逗号分隔的NestJS日志级别(例如. log,warn,error) (中文(简体) ).
MODULE_HUB_ENDPOINT完整报告 URL; 启用模块- hub 自动报告, 当设置在一起时 MODULE_HUB_TOKEN。 。 。 .
MODULE_HUB_TOKEN托肯送入模块中枢.

当两者 MODULE_HUB_ENDPOINT 财务报告和审定财务报表 MODULE_HUB_TOKEN 在座的有: 框架自动发送每60个启动时的完整快照和平分 秒数。 报告是火与忘却的,从来不会阻碍应用程序的启动.

许可证

麻省理工学院

版本与发布记录

@devbie/newbie 共发布 33 个版本，首次发布于 2026/09/25；过去 12 个月发布了 33 个版本。

版本发布日期距今
1.17.0latest2026/11/093 天前
1.16.02026/11/093 天前
1.15.02026/11/093 天前
1.14.02026/11/093 天前
1.13.22026/11/093 天前
1.13.12026/11/093 天前

关于 @devbie/newbie 的常见问题

@devbie/newbie 是什么？

新bie后端框架运行时间

如何安装 @devbie/newbie？

在项目目录运行 npm install @devbie/newbie，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：rxjs（^7.0.0）、express（^5.0.0）、@nestjs/core（^11.0.0 || ^12.0.0）、@nestjs/axios（^4.0.0 || ^12.0.0）、@nestjs/common（^11.0.0 || ^12.0.0）、@nestjs/config（^4.0.0 || ^12.0.0）、@prisma/client（^7.0.0）、@nestjs/swagger（^11.0.0 || ^12.0.0）、reflect-metadata（^0.1.12 || ^0.2.0）、@nestjs/throttler（^6.0.0）、@prisma/adapter-pg（^7.0.0）、@nestjs/platform-express（^11.0.0 || ^12.0.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

@devbie/newbie 支持 TypeScript 吗？

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

@devbie/newbie 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。

@devbie/newbie 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@devbie/newbie 可以商用吗？

@devbie/newbie 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@devbie/newbie 的下载量有多少？

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

@devbie/newbie 还在维护吗？

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