Node-RED 中文

abortMerge(opts) → {Promise.<Object>}

中止正在进行的合并

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

addRemote(opts) → {Promise.<Object>}

参数

名称类型描述

opts

对象

名称类型描述

用户

调用API的用户

id

字符串

项目的id

远程

对象

远程的元数据

名称	类型	描述
`名称`	`字符串`	远程的名称
`url`	`字符串`	远程的url

请求

对象

要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

commit(opts) → {Promise.<Object>}

提交当前暂存的文件

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`消息`	`字符串`	与提交关联的消息
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

createProject(opts) → {Promise.<Object>}

创建新项目

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`项目`	`对象`	项目信息
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

deleteBranch(opts) → {Promise.<Object>}

删除分支

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`分支`	`字符串`	分支的名称
`强制`	`布尔值`	是否强制删除
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

deleteProject(opts) → {Promise.<Object>}

删除项目

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要更新的项目id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

getActiveProject(opts) → {Promise.<Object>}

获取活动项目

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

活动项目

getBranches(opts) → {Promise.<Object>}

获取本地分支列表

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`远程`	`布尔值`	是返回远程分支（true）还是本地分支（false）
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

本地分支列表

getBranchStatus(opts) → {Promise.<Object>}

获取分支状态

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`分支`	`字符串`	分支的名称
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

分支状态

getCommit(opts) → {Promise.<Object>}

获取单个提交的详细信息

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`sha`	`字符串`	要返回的提交的sha
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

提交详情

getCommits(opts) → {Promise.<Array>}

获取项目的提交历史

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`限制`	`字符串`	限制返回数量
`之前`	`字符串`	回溯的提交id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Array>

提交数组

getFile(opts) → {Promise.<String>}

获取文件内容

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`字符串`	文件路径
`树`	`字符串`	要使用的版本控制树
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<String>

文件内容

getFileDiff(opts) → {Promise.<Object>}

获取文件差异

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`字符串`	文件路径
`类型`	`字符串`	差异类型
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

请求的差异

getFiles(opts) → {Promise.<Object>}

获取项目中的文件列表

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

文件列表

getProject(opts) → {Promise.<Object>}

获取项目元数据

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要获取的项目id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

项目元数据

getRemotes(opts) → {Promise.<Object>}

获取项目远程列表

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

项目远程列表

getStatus(opts) → {Promise.<Object>}

获取项目当前git状态

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`远程`	`布尔值`	是否包含远程仓库状态
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

项目状态

initialiseProject(opts) → {Promise.<Object>}

初始化空项目

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要初始化的项目id
`项目`	`对象`	项目信息
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

listProjects(opts) → {Promise.<Object>}

列出运行时已知的项目

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`请求`	`对象`	要记录的请求（可选）
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

pull(opts) → {Promise.<Object>}

从远程拉取更改

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`远程`	`字符串`	要拉取的远程
`跟踪`	`布尔值`	是否跟踪此远程
`allowUnrelatedHistories`	`布尔值`
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

push(opts) → {Promise.<Object>}

将更改推送到远程

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`远程`	`字符串`	远程的名称
`跟踪`	`字符串`	是否将远程设置为上游
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

removeRemote(opts) → {Promise.<Object>}

删除项目远程

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`远程`	`字符串`	远程的名称
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

resolveMerge(opts) → {Promise.<Object>}

解决合并冲突

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`字符串`	正在合并的文件路径
`解决方案`	`字符串`	如何解决合并冲突
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

revertFile(opts) → {Promise.<Object>}

将文件更改恢复到已提交的版本

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`字符串`	文件路径
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

setActiveProject(opts) → {Promise.<Object>}

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要激活的项目id
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

setBranch(opts) → {Promise.<Object>}

设置当前本地分支

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`分支`	`字符串`	分支的名称
`创建`	`布尔值`	如果分支不存在，是否创建
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

stageFile(opts) → {Promise.<Object>}

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`String` \| `Array`	文件路径，或路径数组
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

unstageFile(opts) → {Promise.<Object>}

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	项目的id
`路径`	`字符串`	文件路径。如果未设置，则所有暂存文件都取消暂存
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

updateProject(opts) → {Promise.<Object>}

更新现有项目的元数据

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要更新的项目id
`项目`	`对象`	项目信息
`请求`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

updateRemote(opts) → {Promise.<Object>}

参数

名称类型描述

opts

对象

名称类型描述

用户

调用API的用户

id

字符串

项目的id

远程

对象

远程的元数据

名称	类型	描述
`名称`	`字符串`	远程的名称

请求

对象

要记录的请求（可选）

返回

类型: Promise.<Object>

完成时解析

函数

abortMerge(opts) → {Promise.<Object>}

参数

返回

addRemote(opts) → {Promise.<Object>}

参数

返回

commit(opts) → {Promise.<Object>}

参数

返回

createProject(opts) → {Promise.<Object>}

参数

返回

deleteBranch(opts) → {Promise.<Object>}

参数

返回

deleteProject(opts) → {Promise.<Object>}

参数

返回

getActiveProject(opts) → {Promise.<Object>}

参数

返回

getBranches(opts) → {Promise.<Object>}

参数

返回

getBranchStatus(opts) → {Promise.<Object>}

参数

返回

getCommit(opts) → {Promise.<Object>}

参数

返回

getCommits(opts) → {Promise.<Array>}

参数

返回

getFile(opts) → {Promise.<String>}

参数

返回

getFileDiff(opts) → {Promise.<Object>}

参数

返回

getFiles(opts) → {Promise.<Object>}

参数

返回

getProject(opts) → {Promise.<Object>}

参数

返回

getRemotes(opts) → {Promise.<Object>}

参数

返回

getStatus(opts) → {Promise.<Object>}

参数

返回

initialiseProject(opts) → {Promise.<Object>}

参数

返回

listProjects(opts) → {Promise.<Object>}

参数

返回

pull(opts) → {Promise.<Object>}

参数

返回

push(opts) → {Promise.<Object>}

参数

返回

removeRemote(opts) → {Promise.<Object>}

参数

返回

resolveMerge(opts) → {Promise.<Object>}

参数

返回

revertFile(opts) → {Promise.<Object>}

参数

返回

setActiveProject(opts) → {Promise.<Object>}

参数

返回

setBranch(opts) → {Promise.<Object>}

参数

返回

stageFile(opts) → {Promise.<Object>}