oss-upload-tool/lib/types.d.ts

Integrated oss upload

/// <reference types="node" />
import type COS from 'cos-nodejs-sdk-v5';
import type AOSS from 'ali-oss';
import type { S3ClientConfig, PutObjectCommandInput } from '@aws-sdk/client-s3';
/**
 * 上传参数
 */
declare type UploadParams = Partial<COS.UploadFileParams> | Partial<AOSS.PutObjectOptions> | Partial<PutObjectCommandInput>;
/**
 * 对象存储类型
 */
export declare enum OSSToolClientType {
    COS = 0,
    ALI = 1,
    S3 = 2
}
export interface OSSUploadLocalItem {
    /**
     * 本地文件路径
     */
    filePath: string;
    /**
     * 上传访问路径
     */
    path: string;
    /**
     * 自定义文件内容
     */
    content?: string | Buffer;
}
export interface OSSUploadTarget {
    /**
     * 文件 globby 匹配
     */
    src: string | string[];
    /**
     * 上传目录
     */
    dest: string | string[];
    /**
     * 更改输出文件名
     */
    rename?: ((name: string, ext: string) => string) | string;
    /**
     * 更改输出目录
     * @param path
     */
    transform?: (content: string | Buffer) => string | Buffer;
    /**
     * 删除上传文件的目录结构
     * @default true
     */
    flatten?: boolean;
}
export interface OSSUploadOptions {
    /**
     * 腾讯云初始化SDK参数
     * https://github.com/tencentyun/cos-nodejs-sdk-v5
     */
    COSOptions?: COS.COSOptions;
    /**
     * 阿里云OSS初始化参数
     * https://github.com/ali-sdk/ali-oss#node-usage
     */
    ALIOptions?: AOSS.Options;
    /**
     * S3 初始化参数
     */
    S3Options?: S3ClientConfig;
    /**
     * 当前 CDN 对外访问域名，需要带协议
     * existCheck 检查，如果默认cdn域名无法访问，使用开放访问的 cdn 域名进行检查
     * eg: https://your-customer-domain
     */
    origin?: string;
    /**
     * 上传参数
     */
    uploadParams?: UploadParams;
    /**
     * 对象存储服务商
     * @default COS
     */
    type?: keyof typeof OSSToolClientType;
    /**
     * 需要上传的文件
     */
    targets: OSSUploadTarget[] | OSSUploadTarget;
    /**
     * 日志
     */
    verbose?: boolean;
    /**
     * 并行上传数量
     * @default 5
     */
    parallelLimit?: number;
    /**
     * 上传超时时间
     */
    timeout?: number;
    /**
     * 重试次数
     */
    maxAttempts?: number;
    /**
     * 存在则跳过
     * string 为 globby 匹配中的做检查
     * @default false
     */
    existCheck?: boolean | string | string[];
    /**
     * 匹配执行目录
     * @default process.cwd()
     */
    cwd?: string;
}
export {};