git-neko-kit

外观

User

约 2555 字大约 9 分钟

2025-08-01

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

类: User

定义于: models/platform/github/user.ts:33

Base 用户操作类

提供对GitHub用户的CRUD操作，包括：

  • 获取用户信息
  • 关注指定用户

继承

构造函数

构造函数

new User(base): User

定义于: models/platform/github/user.ts:34

参数

base

GitHubClient

返回

User

重写了

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

方法

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

get()

get(path, parms?, customHeaders?): Promise<ApiResponseType<any>>

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

Github GET 请求方法

参数

path

string

请求路径

parms?

any

请求参数

customHeaders?

Record<string, string>

请求头，选项

返回

Promise<ApiResponseType<any>>

请求结果

继承自

GitHubClient.get

get_app()

get_app(): Promise<App>

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

获取App实例

返回

Promise<App>

App实例

示例

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_avatar_url()

get_avatar_url(): Promise<string>

定义于: models/platform/github/user.ts:329

快速获取获取用户头像地址 该方法会自动获取当前用户的头像地址，需要传入token 权限：无需任何权限

返回

Promise<string>

头像地址

示例

const avatarUrl = await user.get_avatar_url()
-> 'https://avatars.githubusercontent.com/u/12345678?v=4'

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_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_nickname()

get_nickname(): Promise<null | string>

定义于: models/platform/github/user.ts:299

快速获取获取用户昵称 该方法会自动获取当前用户的昵称，需要传入token 权限：无需任何权限

返回

Promise<null | string>

昵称

示例

const nickname = await user.get_nickname()
-> 'loli'

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_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_user_contribution()

get_user_contribution(options): Promise<ApiResponseType<ContributionResult>>

定义于: models/platform/github/user.ts:223

获取用户贡献数据 权限：无需任何权限

参数

options

UserNameParamType

用户参数

  • username: 用户名

返回

Promise<ApiResponseType<ContributionResult>>

用户贡献数据

示例

const contribution = await user.get_user_contribution({ username: 'username' })
->
{
success: true,
status: 'ok',
statusCode: 200,
msg: '请求成功',
data: { total: 5, contributions: [[{ date: '2023-04-16', count: 5 }]] }
}

get_user_email()

get_user_email(): Promise<null | string>

定义于: models/platform/github/user.ts:314

快速获取获取用户邮箱 该方法会自动获取当前用户的邮箱，需要传入token 权限：无需任何权限

返回

Promise<null | string>

邮箱

示例

const email = await user.get_email()
-> '114514@gmail.com'

get_user_id()

get_user_id(): Promise<number>

定义于: models/platform/github/user.ts:269

快速获取获取用户id 权限：无需任何权限 该方法会自动获取当前用户的id，需要传入token

返回

Promise<number>

用户id

示例

const userId = await user.get_user_id()
-> 114514

***

### get\_user\_info()

> **get\_user\_info**(`options`): `Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`UserInfoResponseType`](../../../../interfaces/UserInfoResponseType.md)\>\>

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

获取指定的用户信息
不止可以获取用户信息还可以获取组织信息
权限：无需任何权限

#### 参数

##### options

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

用户参数
- username - 用户名或组织名

#### 返回

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

#### 示例

```ts
const userInfo = await user.get_user_info({ username: 'username' })
-> 用户信息对象

get_user_info_by_auth()

get_user_info_by_auth(): Promise<ApiResponseType<UserInfoResponseType>>

定义于: models/platform/github/user.ts:153

通过访问令牌获取用户信息 权限：无需任何权限

返回

Promise<ApiResponseType<UserInfoResponseType>>

示例

const userInfo = await user.get_user_info_by_token()
-> 用户信息对象

get_user_info_by_token()

get_user_info_by_token(): Promise<ApiResponseType<UserInfoResponseType>>

定义于: models/platform/github/user.ts:199

通过访问令牌获取用户信息 权限：无需任何权限

返回

Promise<ApiResponseType<UserInfoResponseType>>

已被弃用

该方法已过时，请使用get_user_info_by_auth方法牌


***

### get\_user\_info\_by\_user\_id()

> **get\_user\_info\_by\_user\_id**(`options`): `Promise`\<[`ApiResponseType`](../../../../interfaces/ApiResponseType.md)\<[`UserInfoResponseType`](../../../../interfaces/UserInfoResponseType.md)\>\>

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

通过用户id获取用户信息
user_id 不是用户名, 而是github平台上用户的唯一标识符
权限：无需任何权限

#### 参数

##### options

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

用户参数
- user_id： 用户id

#### 返回

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

用户信息

#### 示例

```ts
const userInfo = await user.get_user_info_by_user_id({ user_id: 123456789 })
-> 用户信息对象

get_username()

get_username(): Promise<string>

定义于: models/platform/github/user.ts:284

快速获取获取用户名 权限：无需任何权限 该方法会自动获取当前用户的用户名，需要传入token

返回

Promise<string>

用户名

示例

const username = await user.get_username()
-> 'loli'

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

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