t-comm
Version:
专业、稳定、纯粹的工具库
73 lines (72 loc) • 1.94 kB
TypeScript
/**
* 获取仓库详情
* @param {object} options 输入配置
* @param {string} options.projectName 项目名称
* @param {string} options.privateToken 密钥
* @returns {Promise<object>} 请求Promise
* @example
* getOneProjectDetail({
* projectName: 't-comm',
* privateToken: 'xxxxx',
* }).then((resp) => {
*
* })
*/
export declare function getOneProjectDetail({ projectName, privateToken, baseUrl, }: {
projectName: string;
privateToken: string;
baseUrl?: string;
}): Promise<unknown>;
/**
* 通过搜索获取一个项目信息
* @param {object} options 输入配置
* @param {string} options.search 搜索内容
* @param {string} options.page 起始页码
* @param {string} options.privateToken 密钥
* @returns {Promise<Array<object>>} 请求Promise
* @example
*
* getOneProjectBySearch({
* search: 't-comm',
* page: 1,
* privateToken: 'xxxxx',
* }).then((resp) => {
*
* })
*/
export declare function getOneProjectBySearch({ search, privateToken, page, }: {
search: string;
privateToken: string;
page?: number;
}): Promise<Array<object>>;
/**
* 获取某个token名下所有项目
* @param {string} privateToken 密钥
* @param {string} search 搜索内容
* @returns {Array<object>} 项目列表
* @example
*
* const projects = await getAllProjects('xxxxx');
*
* console.log(projects)
*/
export declare function getAllProjects(privateToken: string, search?: string): Promise<Array<object>>;
/**
* 删除一个项目
* @param {object} options 输入配置
* @param {string} options.id 项目id
* @param {string} options.privateToken 密钥
* @returns {Promise<Array<object>>} 请求Promise
* @example
*
* deleteTGitProject({
* id: '123'
* privateToken: 'xxxxx',
* }).then((resp) => {
*
* })
*/
export declare function deleteTGitProject({ id, privateToken, }: {
id: number | string;
privateToken: string;
}): Promise<Array<object>>;