# @dev-thought/nestjs-github-webhooks 中文文档

规范地址：https://npmcn.com/package/%40dev-thought/nestjs-github-webhooks/

版本：1\.0\.0
npm 元数据更新时间：2022-04-05T04:02:20.767Z
中文译文更新时间：2026-11-12T01:57:09.087Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dev-thought/nestjs-github-webhooks
原文对照：https://npmcn.com/package/%40dev-thought/nestjs-github-webhooks/?lang=original

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

- 包体积（解压后）：29.3 kB，21 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：@nestjs/core ^6\.4\.0，reflect-metadata ^0\.1\.12
- 首次发布：2019-12-09T19:57:20.748Z
- 最新版本发布：2019-12-09T19:57:21.508Z
- 近 30 天下载量：12246（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

用 NestJs 连接您的 Github webhooks - 现代、快速、强大的节点.js 网络框架

## 安装

```sh
npm install @dev-thought/nestjs-github-webhooks
```

也可以使用：`pnpm add @dev-thought/nestjs-github-webhooks`、`yarn add @dev-thought/nestjs-github-webhooks`、`bun add @dev-thought/nestjs-github-webhooks`

## README

[![Nest Logo](https://nestjs.com/img/logo_text.svg)](http://nestjs.com/)

一个进步 [节点.js](http://nodejs.org/) 建立高效和可扩展的服务器侧应用程序的框架,深受 [角质](https://angular.io/)。 。 。 .

[![NPM Version](https://img.shields.io/npm/v/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![Package License](https://img.shields.io/npm/l/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![NPM Downloads](https://img.shields.io/npm/dm/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![CircleCI](https://img.shields.io/circleci/build/github/nestjs/nest/master)](https://circleci.com/gh/nestjs/nest) [![Coverage](https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5)](https://coveralls.io/github/nestjs/nest?branch=master) [![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)](https://discord.gg/G7Qnnhy) [![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer) [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor) [![](https://img.shields.io/badge/Donate-PayPal-dc3d53.svg)](https://paypal.me/kamilmysliwiec) [![](https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow)](https://twitter.com/nestframework)

## 说明

[Github 网络呼号](https://developer.github.com/webhooks/) 模块 [鸟巢](https://github.com/nestjs/nest)。 。 。 .

## 安装

```bash
$ npm i --save @dev-thought/nestjs-github-webhooks
```

## 快速启动

### 导入模块

```typescript
@Module({
  imports: [
    ...
    GithubWebhooksModule.forRoot({
      webhookSecret: 'YOUR_WEBHOOK_APIKEY'
    }),
  ];
})
class AppModule {}
```

### Async 导入示例

```typescript
@Module({
  imports: [
    ...
    GithubWebhooksModule.forRootAsync({
      useFactory: () => ({ webhookSecret: 'SomeSecret' })
    })
  ];
})
class AppModule {}
```

### 用护卫

```typescript
@Controller()
export class AppController {

  @UseGuards(GithubGuard)
  @Post()
  githubWebhoook() {
    ...
  }

  @UseGuards(GithubGuard)
  @GithubWebhookEvents(['push', 'pullrequest'])
  @Post('withGithubEvent')
  withRestrictedGithubEvents() {
    ...
  }
}
```

## 教学

你可以读到更多关于这个融合 马上就来了

## 支助

Nest是麻省理工学院许可的开源项目. 它可以增长多亏赞助商和惊人的支持者的支持. 如果你想加入他们,请 [这里读更多](https://docs.nestjs.com/support)。 。 。 .

## 保持联系

-   雀巢JS的作者 Github Webhooks 模块 - [米特克·齐梅夫](https://github.com/MitkoTschimev)
-   微博作者 - [米特克·齐梅夫](https://twitter.com/MTschimev)
-   作者雀巢JS - [卡米尔·迈利维克(英语:Kamil Myśliwiec)](https://kamilmysliwiec.com/)
-   网站 NestJS - [https://nestjs.com (中文(简体) )](https://nestjs.com/)
-   Twitter NestJS (英语) [@ 无框架](https://twitter.com/nestframework)

## 许可证

此模块是 [麻省理工学院执照](https://npmcn.com/package/%40dev-thought/nestjs-github-webhooks/LICENSE)。 。 。 .

## 常见问题

### @dev-thought/nestjs-github-webhooks 是什么？

用 NestJs 连接您的 Github webhooks - 现代、快速、强大的节点\.js 网络框架

### 如何安装 @dev-thought/nestjs-github-webhooks？

在项目目录运行 npm install @dev-thought/nestjs-github-webhooks，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/core（^6\.4\.0）、reflect-metadata（^0\.1\.12）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dev-thought/nestjs-github-webhooks 支持 TypeScript 吗？

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

### @dev-thought/nestjs-github-webhooks 可以商用吗？

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

### @dev-thought/nestjs-github-webhooks 的下载量有多少？

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

### @dev-thought/nestjs-github-webhooks 还在维护吗？

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