t-comm
Version:
专业、稳定、纯粹的工具库
45 lines (44 loc) • 1.16 kB
TypeScript
import type { DeployPagesOptions, DeployPagesResult } from './types';
/**
* 部署本地目录到 OA Pages
*
* @param options - 部署配置
* @returns 部署结果
*
* @example
* ```ts
* import { deployPages } from 't-comm';
*
* // 基本用法
* const result = await deployPages({
* cname: 't-comm.pages.woa.com',
* directory: 'docs/.vitepress/dist',
* visibility: 'public',
* });
*
* // 传入 API Key（不依赖环境变量）
* const result = await deployPages({
* cname: 't-comm',
* directory: './dist',
* apiKey: 'oa-pages-key-xxxxxxxx',
* visibility: 'tof',
* description: '我的网站',
* });
*
* // 部署前先清理远程历史文件（避免容量超限上传失败）
* await deployPages({
* cname: 't-comm.pages.woa.com',
* directory: './dist',
* cleanBeforeDeploy: true,
* });
*
* // 仅清理 assets/ 前缀下的文件，再上传
* await deployPages({
* cname: 't-comm.pages.woa.com',
* directory: './dist',
* cleanBeforeDeploy: true,
* cleanPrefix: 'assets/',
* });
* ```
*/
export declare function deployPages(options: DeployPagesOptions): Promise<DeployPagesResult>;