git-neko-kit

外观

Pull_Request

约 3326 字大约 11 分钟

2025-08-01

@candriajs/git-neko-kit / github / Pull_Request

类: Pull_Request

定义于: models/platform/github/pull_request.ts:66

GitHub pull_request类

提供完整的GitHub pull_request管理，包括

  • 获取pull_request列表
  • 获取pull_request详情

Auth

继承

构造函数

构造函数

new Pull_Request(base): Pull_Request

定义于: models/platform/github/pull_request.ts:67

参数

base

GitHubClient

返回

Pull_Request

重写了

GitHubClient.constructor

属性

api_url

api_url: string

定义于: models/platform/github/client.ts:79

继承自

GitHubClient.api_url

app

app: App

定义于: models/platform/github/client.ts:67

继承自

GitHubClient.app

auth

auth: Auth

定义于: models/platform/github/client.ts:68

继承自

GitHubClient.auth

base_url

base_url: string

定义于: models/platform/github/client.ts:78

继承自

GitHubClient.base_url

Client_ID?

readonly optional Client_ID: null | string

定义于: models/platform/github/client.ts:83

继承自

GitHubClient.Client_ID

Client_Secret?

readonly optional Client_Secret: null | string

定义于: models/platform/github/client.ts:84

继承自

GitHubClient.Client_Secret

commit

commit: Commit

定义于: models/platform/github/client.ts:69

继承自

GitHubClient.commit

format

readonly format: boolean

定义于: models/platform/github/client.ts:86

继承自

GitHubClient.format

issue

issue: Issue

定义于: models/platform/github/client.ts:73

继承自

GitHubClient.issue

jwtToken

jwtToken: string

定义于: models/platform/github/client.ts:80

继承自

GitHubClient.jwtToken

org

org: Org

定义于: models/platform/github/client.ts:74

继承自

GitHubClient.org

Private_Key?

readonly optional Private_Key: null | string

定义于: models/platform/github/client.ts:82

继承自

GitHubClient.Private_Key

pull_request

pull_request: Pull_Request

定义于: models/platform/github/client.ts:75

继承自

GitHubClient.pull_request

repo

repo: Repo

定义于: models/platform/github/client.ts:70

继承自

GitHubClient.repo

search: Search

定义于: models/platform/github/client.ts:77

继承自

GitHubClient.search

user

user: User

定义于: models/platform/github/client.ts:71

继承自

GitHubClient.user

userToken?

optional userToken: null | string

定义于: models/platform/github/client.ts:81

继承自

GitHubClient.userToken

webhook

webhook: WebHook

定义于: models/platform/github/client.ts:72

继承自

GitHubClient.webhook

WebHook_Secret?

readonly optional WebHook_Secret: null | string

定义于: models/platform/github/client.ts:85

继承自

GitHubClient.WebHook_Secret

workflow

workflow: Workflow

定义于: models/platform/github/client.ts:76

继承自

GitHubClient.workflow

访问器

is_app_client

Getter 签名

get is_app_client(): boolean

定义于: models/platform/github/client.ts:130

是否是App客户端

示例
const isAppClient = await client.is_app_client
-> true
返回

boolean

是否是App客户端

继承自

GitHubClient.is_app_client

type

Getter 签名

get type(): GitType

定义于: models/platform/github/client.ts:117

获取Git平台类型

示例
const type = await client.type
-> 'github'
返回

GitType

Git平台类型，如: github,gitee

继承自

GitHubClient.type

方法

create_pull_request()

create_pull_request(options): Promise<ApiResponseType<PullRequestInfoResponseType>>

定义于: models/platform/github/pull_request.ts:442

创建一个拉取请求 权限:

  • Pull requests: Read-And-Write

参数

options

CreatePullRequestParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • title 标题
  • body 内容
  • issue 关联的议题 title和body与issue参数传入其中一种，当传入issue参数时，title和body参数将自动填充
  • head 拉取请求源分支
  • head_repo 拉取请求源仓库, 如果两个存储库都由同一组织拥有，则跨存储库拉取请求需要此字段
  • base 拉取请求目标分支
  • draft 是否为草稿

返回

Promise<ApiResponseType<PullRequestInfoResponseType>>

包含pull_request信息的响应对象

示例

const res = await pull_request.create_pull_requestt({ owner: 'owner', repo:'repo', issue: 1, head: 'head', base: 'base' })
-> 创建拉取提交信息对象

***

### create\_pull\_request\_comment()

> **create\_pull\_request\_comment**(`options`): `Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`CreatePullRequestCommentResponseType`](../../../../interfaces/CreatePullRequestCommentResponseType.md)\>\>

定义于: [models/platform/github/pull\_request.ts:1096](https://github.com/CandriaJS/git-neko-kit/blob/68e1dc12fd1bcb6fcbe1a2aa6869f49f3640b1b1/src/models/platform/github/pull_request.ts#L1096)

创建拉取请求评论
权限:
- Pull requests: Read-And-Write

#### 参数

##### options

[`CreatePullRequestCommentParamType`](../../../../interfaces/CreatePullRequestCommentParamType.md)

请求参数列表
- owner 仓库拥有者
- repo 仓库名称
- pr_number 拉取请求编号
- body 评论内容

#### 返回

`Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`CreatePullRequestCommentResponseType`](../../../../interfaces/CreatePullRequestCommentResponseType.md)\>\>

包含创建拉取请求评论响应信息

#### 示例

```ts
const res = await pull_request.create_pull_request_comment({ owner: 'owner', repo:'repo', pr_number:1， body: 'loli' })
-> 创建拉取提交评论信息对象

delete()

delete(path, params, data?, customHeaders?): Promise<ApiResponseType<any>>

定义于: models/platform/github/client.ts:602

Github DELETE 请求方法

参数

path

string

请求路径

params

URL查询参数

null | Record<string, string>

data?

any

请求体数据

customHeaders?

Record<string, string>

请求头，选项

返回

Promise<ApiResponseType<any>>

请求结果

继承自

GitHubClient.delete

delete_pull_request_comment()

delete_pull_request_comment(options): Promise<ApiResponseType<DeletePullRequestCommentResponseType>>

定义于: models/platform/github/pull_request.ts:1210

删除拉取请求评论 权限:

  • Pull requests: Read-And-Write

参数

options

DeletePullRequestCommentParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • comment_id 评论ID

返回

Promise<ApiResponseType<DeletePullRequestCommentResponseType>>

包含更新拉取请求评论响应信息

示例

const res = await pull_request.delete_pull_request_comment({ owner: 'owner', repo:'repo', comment_id: 1 })
-> 更新拉取提交评论信息对象

edit_pull_request_comment()

edit_pull_request_comment(options): Promise<ApiResponseType<UpdatePullRequestCommentResponseType>>

定义于: models/platform/github/pull_request.ts:1189

编辑拉取请求评论

参数

options

UpdatePullRequestCommentParamType

删除拉取请求评论参数对象

返回

Promise<ApiResponseType<UpdatePullRequestCommentResponseType>>

删除结果


#### 已被弃用

请使用update_issue_comment方法
权限:
- Pull requests: Read-And-Write

***

### get()

> **get**(`path`, `parms?`, `customHeaders?`): `Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<`any`\>\>

定义于: [models/platform/github/client.ts:455](https://github.com/CandriaJS/git-neko-kit/blob/68e1dc12fd1bcb6fcbe1a2aa6869f49f3640b1b1/src/models/platform/github/client.ts#L455)

Github GET 请求方法

#### 参数

##### path

`string`

请求路径

##### parms?

`any`

请求参数

##### customHeaders?

`Record`\<`string`, `string`\>

请求头，选项

#### 返回

`Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<`any`\>\>

请求结果

#### 继承自

[`GitHubClient`](../../../../classes/GitHubClient.md).[`get`](../../../../classes/GitHubClient.md#get)

***

### get\_app()

> **get\_app**(): `Promise`\<[`App`](App.md)\>

定义于: [models/platform/github/client.ts:177](https://github.com/CandriaJS/git-neko-kit/blob/68e1dc12fd1bcb6fcbe1a2aa6869f49f3640b1b1/src/models/platform/github/client.ts#L177)

获取App实例

#### 返回

`Promise`\<[`App`](App.md)\>

App实例

#### 示例

```ts
const app = await GitHubClient.get_app()

继承自

GitHubClient.get_app

get_auth()

get_auth(): Promise<Auth>

定义于: models/platform/github/client.ts:191

获取Auth实例

返回

Promise<Auth>

Auth实例

示例

const auth = await GitHubClient.get_auth()

继承自

GitHubClient.get_auth

get_commit()

get_commit(): Promise<Commit>

定义于: models/platform/github/client.ts:205

获取Commit实例

返回

Promise<Commit>

Commit实例

示例

const commit = await GitHubClient.get_commit()

继承自

GitHubClient.get_commit

get_get_pull_request_list()

get_get_pull_request_list(options): Promise<ApiResponseType<PullRequestListResponseType>>

定义于: models/platform/github/pull_request.ts:276

获取拉取请求列表 权限:

  • Pull requests: Read-Only

参数

options

PullRequestListParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • pr_number Pr编号
  • state 状态
  • base 基准分支
  • sort 排序
  • direction 排序方向
  • per_page 每页数量
  • page 页码

返回

Promise<ApiResponseType<PullRequestListResponseType>>

包含pull_request信息的响应对象

示例

const res = await pull_request.get_get_pull_request_list({ owner: 'owner', repo:'repo' })
-> 拉取提交信息对象列表

get_issue()

get_issue(): Promise<Issue>

定义于: models/platform/github/client.ts:219

获取Issue实例

返回

Promise<Issue>

Issue实例

示例

const issue = await GitHubClient.get_issue()

继承自

GitHubClient.get_issue

get_org()

get_org(): Promise<Org>

定义于: models/platform/github/client.ts:261

获取Org实例

返回

Promise<Org>

Org实例

示例

const org = await GitHubClient.get_org()

继承自

GitHubClient.get_org

get_pull_request()

get_pull_request(): Promise<Pull_Request>

定义于: models/platform/github/client.ts:289

获取Pull_request实例

返回

Promise<Pull_Request>

Pull_request实例

示例

const pull_request = await GitHubClient.get_pull_request()

继承自

GitHubClient.get_pull_request

get_pull_request_comment_info()

get_pull_request_comment_info(options): Promise<ApiResponseType<GetPullRequestCommentInfoResponseType>>

定义于: models/platform/github/pull_request.ts:971

获取拉取请求评论信息 权限:

  • Pull requests: Read-And-Write

参数

options

GetPullRequestCommentInfoParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • comment_id 评论ID

返回

Promise<ApiResponseType<GetPullRequestCommentInfoResponseType>>

包含拉取请求指定的评论id的信息

示例

const res = await pull_request.get_pull_request_comment_info({ owner: 'owner', repo:'repo', comment_id:1 })
-> 拉取提交评论信息对象

get_pull_request_comments_list()

get_pull_request_comments_list(options): Promise<ApiResponseType<GetPullRequestCommentsListResponseType>>

定义于: models/platform/github/pull_request.ts:1035

获取拉取请求评论列表 权限:

  • Pull requests: Read-And-Write

参数

options

GetPullRequestCommentsListParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • pr_number 拉取请求编号
  • direction 排序方向
  • per_page 每页结果数量
  • page 页码

返回

Promise<ApiResponseType<GetPullRequestCommentsListResponseType>>

包含拉取请求评论列表响应信息列表

示例

const res = await pull_request.get_pull_request_comments_list({ owner: 'owner', repo:'repo', pr_number:1 })
-> 拉取提交评论信息对象

get_pull_request_diff()

get_pull_request_diff(options): Promise<ApiResponseType<string>>

定义于: models/platform/github/pull_request.ts:878

参数

options

GetPullRequestDiffParamType

返回

Promise<ApiResponseType<string>>

get_pull_request_files_list()

get_pull_request_files_list(options): Promise<ApiResponseType<GetPullRequestFilesListResponseType>>

定义于: models/platform/github/pull_request.ts:914

获取拉取请求文件列表 权限:

  • Pull requests: Read-And-Write

参数

options

GetPullRequestFilesListParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • pr_number 拉取请求编号
  • per_page 每页结果数量
  • page 页码

返回

Promise<ApiResponseType<GetPullRequestFilesListResponseType>>

包含拉取请求文件列表的响应对象

示例

const res = await pull_request.get_pull_request_files_list({ owner: 'owner', repo:'repo', pr_number:1 })
-> 拉取提交文件信息对象列表

get_pull_request_info()

get_pull_request_info(options): Promise<ApiResponseType<PullRequestInfoResponseType>>

定义于: models/platform/github/pull_request.ts:90

获取拉取请求详情 权限:

  • Pull requests: Read-And-Wirte
  • Contents: Read-And-Wirte

参数

options

PullRequestInfoParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • pr_number Pr编号

返回

Promise<ApiResponseType<PullRequestInfoResponseType>>

包含pull_request信息的响应对象

示例

const res = await pull_request.get_pull_request_info({ owner: 'owner', repo:'repo', pr_number:1 })
-> 拉取提交信息对象

get_repo()

get_repo(): Promise<Repo>

定义于: models/platform/github/client.ts:233

获取Repo实例

返回

Promise<Repo>

Repo实例

示例

const repo = await GitHubClient.get_repo()

继承自

GitHubClient.get_repo

get_search(): Promise<Search>

定义于: models/platform/github/client.ts:317

获取Search实例

返回

Promise<Search>

Search实例

示例

const search = await GitHubClient.get_search()

继承自

GitHubClient.get_search

get_user()

get_user(): Promise<User>

定义于: models/platform/github/client.ts:247

获取User实例

返回

Promise<User>

User实例

示例

const user = await GitHubClient.get_user()

继承自

GitHubClient.get_user

get_webhook()

get_webhook(): Promise<WebHook>

定义于: models/platform/github/client.ts:275

获取WebHook实例

返回

Promise<WebHook>

WebHook实例

示例

const webhook = await GitHubClient.get_webhook()

继承自

GitHubClient.get_webhook

get_workflow()

get_workflow(): Promise<Workflow>

定义于: models/platform/github/client.ts:303

获取Workflow实例

返回

Promise<Workflow>

Workflow实例

示例

const workflow = await GitHubClient.get_workflow()

继承自

GitHubClient.get_workflow

merge_pull_request()

merge_pull_request(options): Promise<ApiResponseType<MergePullRequestResponseType>>

定义于: models/platform/github/pull_request.ts:833

合并拉取请求 权限:

  • Pull requests: Read-And-Write

参数

options

MergePullRequestParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • pr_number 拉取请求编号
  • commit_title 合并提交标题
  • commit_message 合并提交信息
  • sha 拉取请求头部必须匹配的 SHA 才能允许合并
  • merge_method 拉取请求合并方式, 默认为 merge

返回

Promise<ApiResponseType<MergePullRequestResponseType>>

包含pull_request信息的响应对象

示例

const res = await pull_request.merge_pull_request({ owner: 'owner', repo:'repo', pr_number:1 })
-> 合并拉取提交信息对象

patch()

patch(path, params, data, customHeaders?): Promise<ApiResponseType<any>>

定义于: models/platform/github/client.ts:528

Github PATCH 请求方法

参数

path

string

请求路径

params

URL查询参数

null | Record<string, string>

data

any

请求数据

customHeaders?

Record<string, string>

请求头，选项

返回

Promise<ApiResponseType<any>>

请求结果

继承自

GitHubClient.patch

post()

post(path, data, customHeaders?): Promise<ApiResponseType<any>>

定义于: models/platform/github/client.ts:491

Github POST 请求方法

参数

path

string

请求路径

data

any

请求数据

customHeaders?

Record<string, string>

请求头，选项

返回

Promise<ApiResponseType<any>>

请求结果

继承自

GitHubClient.post

put()

put(path, data, customHeaders?): Promise<ApiResponseType<any>>

定义于: models/platform/github/client.ts:565

Github PUT 请求方法

参数

path

string

请求路径

data

any

请求数据

customHeaders?

Record<string, string>

请求头，选项

返回

Promise<ApiResponseType<any>>

请求结果

继承自

GitHubClient.put

setProxy()

setProxy(proxy): void

定义于: models/platform/github/client.ts:343

设置请求代理

参数

proxy

ProxyParamsType

代理参数

返回

void

示例

setProxy({
   type: 'http',
   address: 'http://127.0.0.1:7890'
})

继承自

GitHubClient.setProxy

setRequestConfig()

protected setRequestConfig(config): void

定义于: models/platform/github/client.ts:428

设置当前请求的配置

  • 仅在父类与子类中方法中可访问

参数

config

RequestConfigType

配置对象，包含以下属性:

  • url: 请求的URL
  • token: 认证令牌
  • tokenType: 认证令牌类型，默认为 'Bearer'

返回

void

继承自

GitHubClient.setRequestConfig

setToken()

setToken(token): void

定义于: models/platform/github/client.ts:390

设置 token 传入的 token 必须以 ghu_ 或 ghp_ 或 ghs_ 开头，否则会抛出错误

参数

token

string

传入的 token

返回

void

示例

setToken('ghu_xxxx')

继承自

GitHubClient.setToken

update_pull_request()

update_pull_request(options): Promise<ApiResponseType<PullRequestInfoResponseType>>

定义于: models/platform/github/pull_request.ts:643

更新一个拉取请求 权限:

  • Pull requests: Read-And-Write

参数

options

UpdatePullRequestParamType

请求参数列表

  • owner 仓库拥有者
  • repo 仓库名称
  • title 标题
  • body 内容
  • state 状态

返回

Promise<ApiResponseType<PullRequestInfoResponseType>>

包含pull_request信息的响应对象

示例

const res = await pull_request.create_pull_requestt({ owner: 'owner', repo:'repo', pr_number:1, state:'open' })
-> 更新拉取提交信息对象

***

### update\_pull\_request\_comment()

> **update\_pull\_request\_comment**(`options`): `Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`UpdatePullRequestCommentResponseType`](../../../../interfaces/UpdatePullRequestCommentResponseType.md)\>\>

定义于: [models/platform/github/pull\_request.ts:1143](https://github.com/CandriaJS/git-neko-kit/blob/68e1dc12fd1bcb6fcbe1a2aa6869f49f3640b1b1/src/models/platform/github/pull_request.ts#L1143)

更新拉取请求评论
权限:
- Pull requests: Read-And-Write

#### 参数

##### options

[`UpdatePullRequestCommentParamType`](../../../../interfaces/UpdatePullRequestCommentParamType.md)

请求参数列表
- owner 仓库拥有者
- repo 仓库名称
- comment_id 评论ID
- body 评论内容

#### 返回

`Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`UpdatePullRequestCommentResponseType`](../../../../interfaces/UpdatePullRequestCommentResponseType.md)\>\>

包含更新拉取请求评论响应信息

#### 示例

```ts
const res = await pull_request.update_pull_request_comment({ owner: 'owner', repo:'repo', comment_id:1， body: 'loli' })
-> 更新拉取提交评论信息对象