Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UFile

Hierarchy

  • UFile

Index

Constructors

Properties

bucketName: string
domain: string
got: Got
priKey: string
pubKey: string
scheme: string

Methods

  • abortMultipartUpload(key: string, uploadId: string): Promise<void>
  • 放弃分片

    Parameters

    • key: string

      文件名

    • uploadId: string

      分片id

    Returns Promise<void>

  • deleteFile(key: string): Promise<void>
  • 删除文件

    Parameters

    • key: string

    Returns Promise<void>

  • 完成分片

    Parameters

    • key: string

      文件名

    • uploadId: string

      分片id

    • Optional parts: string[]

      分片的etag们

    • Optional newKey: string

    Returns Promise<IFinishMultipartUploadRes>

  • getFile(key: string, range?: string, ifModifiedSince?: string): Promise<Buffer>
  • 下载文件

    Parameters

    • key: string

      key

    • Optional range: string
    • Optional ifModifiedSince: string

    Returns Promise<Buffer>

  • getFileStream(key: string, range?: string, ifModifiedSince?: string): Promise<Readable>
  • 下载文件

    Parameters

    • key: string

      key

    • Optional range: string
    • Optional ifModifiedSince: string

    Returns Promise<Readable>

  • listObjects(prefix: string, marker?: string, maxKeys?: number, delimiter?: string): Promise<IListObjectsRes>
  • 获取目录文件列表

    Parameters

    • prefix: string
    • Optional marker: string
    • Optional maxKeys: number
    • Optional delimiter: string

    Returns Promise<IListObjectsRes>

  • opMeta(key: string, mimeType: string): Promise<void>
  • 操作文件的Meta信息

    Parameters

    • key: string

      key

    • mimeType: string

      文件的mimetype

    Returns Promise<void>

  • prefixFileList(prefix?: string, marker?: string, limit?: number): Promise<IPrefixFileListRes>
  • putFile(key: string, file: string | Buffer | Readable, mimeType?: string): Promise<void>
  • 上传文件

    Parameters

    • key: string
    • file: string | Buffer | Readable

      文件

    • mimeType: string = defaultMimeType

    Returns Promise<void>

  • restore(key: string): Promise<void>
  • 解冻文件

    Parameters

    • key: string

    Returns Promise<void>

  • sign(options: default): string
  • Parameters

    • options: default

    Returns string

  • uploadFile(key: string, path: string, mimeType?: string): Promise<void>
  • 上传本地文件

    Parameters

    • key: string
    • path: string

      文件路径

    • mimeType: string = defaultMimeType

    Returns Promise<void>

  • uploadHit(hash: string, fileName: string, fileSize: string): Promise<boolean>
  • 秒传文件

    Parameters

    • hash: string

      待上传文件的ETag,详见ETag生成文档

    • fileName: string

      Bucket中文件的名称

    • fileSize: string

      待上传文件的大小

    Returns Promise<boolean>

  • uploadPart(key: string, uploadId: string, partNumber: number, buffer: Buffer): Promise<IUploadPartRes>
  • 上传分片

    Parameters

    • key: string

      文件名

    • uploadId: string

      分片id

    • partNumber: number

      第几块分片

    • buffer: Buffer

      内容

    Returns Promise<IUploadPartRes>

Generated using TypeDoc