t-comm
Version:
专业、稳定、纯粹的工具库
67 lines (66 loc) • 2.12 kB
TypeScript
/**
* 获取commit详情
* @param {object} options 输入配置
* @param {string} options.projectName 项目名称
* @param {string} options.commitId 提交hash
* @param {string} options.privateToken 密钥
* @param {string} [options.baseUrl] 自定义 API 基础路径
* @returns {Promise<object>} 请求Promise
* @example
*
* getOneCommitDetail({
* projectName: 't-comm',
* commitId: 'aaaa',
* privateToken: 'xxxxx',
* }).then((resp) => {
*
* })
*/
export declare function getOneCommitDetail({ projectName, commitId, privateToken, baseUrl }: {
projectName: string;
commitId: string;
privateToken: string;
baseUrl?: string;
}): Promise<object>;
/**
* 获取分支上的最新若干条 commit
*
* 对应工蜂 API：GET /api/v3/projects/:id/repository/commits
*
* 典型场景：通过 PUT files 接口更新文件后，该接口不返回 commit_id，
* 可用本函数回查真实的 commit sha。
*
* @param {object} options 输入配置
* @param {string | number} options.projectName 项目名称或项目 ID
* @param {string} [options.refName] 分支名或 commit sha，默认由后端使用默认分支
* @param {number} [options.perPage=1] 每页条数
* @param {number} [options.page] 页码
* @param {string} options.privateToken 密钥
* @param {string} [options.baseUrl] baseUrl
* @returns {Promise<Array<{ id: string; short_id: string; title?: string; message?: string; created_at?: string }>>} commit 列表
* @example
*
* // 拉取 master 分支最近 5 条 commit
* getLatestCommits({
* projectName: 'group/sub/repo',
* refName: 'master',
* perPage: 5,
* privateToken: 'xxxxx',
* }).then((list) => {
* console.log(list[0].id); // commit sha
* })
*/
export declare function getLatestCommits({ projectName, refName, perPage, page, privateToken, baseUrl, }: {
projectName: string | number;
refName?: string;
perPage?: number;
page?: number;
privateToken: string;
baseUrl?: string;
}): Promise<Array<{
id: string;
short_id: string;
title?: string;
message?: string;
created_at?: string;
}>>;