@mypaas/hcm-cli/lib/common/oss/index.d.ts

Vant Cli 是一个 Vue 组件库构建工具，通过 Vant Cli 可以快速搭建一套功能完备的 Vue 组件库。

/// <reference types="node" />
import { DeleteMultiOptions } from './utils';
import { Options, ObjectMeta, HeadObjectOptions, HeadObjectResult, ListObjectsQuery, UserMeta, CopyAndPutMetaResult, GetObjectResult, PutObjectResult } from 'ali-oss';
export declare class Oss {
    private readonly client;
    options: Options;
    constructor(options: Options);
    /**
     * 遍历 object
     * @param prefix
     * @param callback
     * @param options
     * @return {Promise}
     */
    traversal(prefix: string, callback: (param: ObjectMeta) => any, options?: ListObjectsQuery): Promise<ObjectMeta[]>;
    /**
     * 判断是否存在
     * @param uri
     * @param options
     * @return {Promise<boolean>}
     */
    exists(uri: string, options?: HeadObjectOptions): Promise<HeadObjectResult>;
    /**
     * 获取 meta 信息
     * @param uri
     * @param options
     * @return {Promise}
     */
    getMeta(uri: string, options?: HeadObjectOptions): Promise<any>;
    putMeta(uri: string, meta: UserMeta, options?: {}): Promise<CopyAndPutMetaResult>;
    /**
     * 获取 head 信息
     * @param uri
     * @param options
     * @return {Promise}
     */
    head(uri: string, options?: {}): Promise<HeadObjectResult>;
    /**
     * 下载文件
     * @param uri
     * @param file
     * @param options
     * @return {Promise}
     */
    download(uri: string, file: string, options: Record<string, unknown>): Promise<GetObjectResult | string>;
    /**
     * 获取 String 资源到内存
     * @param uri
     * @param options
     * @return {PromiseLike<string> | Promise<string>}
     */
    getString(uri: string, options?: {}): Promise<string>;
    /**
     * 从内存写 String 数据到 OSS
     * @param uri
     * @param data
     * @param options
     * @return {*}
     */
    putString(uri: string, data: string, options?: {}): Promise<string | PutObjectResult>;
    /**
     * 获取 JSON 资源到内存
     * @param uri
     * @param options
     * @return {PromiseLike<Object|Array> | Promise<Object|Array>}
     */
    getJSON<T>(uri: string, options?: {}): Promise<T>;
    /**
     * 从内存写 JSON 数据到 OSS
     * @param uri
     * @param data
     * @param options
     * @return {*}
     */
    putJSON(uri: string, data: string | Record<string, unknown> | Record<string, unknown>[] | Array<any>, options?: Record<string, any>): Promise<PutObjectResult | string>;
    /**
     * 下载整个目录到指定目录
     * @param uri
     * @param dir
     * @param options
     * @return {Promise}
     */
    downloadDir(uri: string, dir: string, options?: {}): Promise<any>;
    /**
     * 下载给定 uris 数组的所有文件
     * @param uris
     * @param dir
     * @param options
     * @return {Promise}
     */
    downloadFiles(uris: string[], dir: string, options?: {}): Promise<any[]>;
    /**
     * 上传文件
     * @param uri
     * @param file
     * @param options
     * @return {*}
     */
    upload(uri: string, file: string | Buffer | ReadableStream, options?: {}): Promise<string | PutObjectResult>;
    /**
     * 上传整个目录
     * @param uri
     * @param dir
     * @param options
     * @return {*}
     */
    uploadDir(uri: string, dir: string, options?: Record<string, any>): Promise<PutObjectResult[]>;
    /**
     * 列出指定前缀的 objects
     * @param dir
     * @param options
     * @return {*}
     */
    list(dir: string, options?: Record<string, unknown>): Promise<string[]>;
    /**
     * 删除指定前缀的 objects
     * @param dir
     * @param options
     * @return {*}
     */
    deleteDir(dir: string, options?: DeleteMultiOptions): Promise<string[]>;
    /**
     * 删除指定的 object
     * @param file
     * @param options
     * @return {Promise}
     */
    delete(file: string, options?: {}): Promise<string[]>;
    /**
     * 删除指定的 objects
     * @param files
     * @param options
     * @return {*}
     */
    deleteFiles(files: string[], options?: {}): Promise<string[]>;
    copy(sourceFile: string, targetFile: string, options?: {}): Promise<string>;
    /**
     * 根据指定 sourceDir、targetDir 进行拷贝
     * @param sourceDir
     * @param targetDir
     * @param options
     * @return {*}
     */
    copyDir(sourceDir: string, targetDir: string, options?: {}): Promise<any[]>;
    /**
     * 创建软链接
     * @param symlinkUri
     * @param targetUri
     * @param options
     */
    putSymlink(symlinkUri: string, targetUri: string, options?: {}): Promise<any>;
}