Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Status

状态类

Hierarchy

Index

Properties

Accessors

Methods

Properties

_statusHandlers

_statusHandlers: {}

储存状态处理函数

memberof

Status

Type declaration

  • [key: string]: Function

error

error: Error[] = []

错误数组

memberof

Status

status

status: STATUS = STATUS.PENDING

状态

memberof

Status

tryCount

tryCount: number = 0

重试次数

memberof

Status

Static default

default: { AuthorizationStorageKey: string; AuthorizationTokenKey: string; blockSize: number; chunkRetry: number; chunkSize: number; concurrency: number; taskConcurrencyInWorkers: number; apis: object; clientConfig: object } = UploaderConfig

全局共享的上传配置

static
memberof

Base

Type declaration

  • AuthorizationStorageKey: string

    如您使用的是localstorage储存的Auth信息，uploader将会从以下key获取值填入 AuthorizationToken 请求头中

  • AuthorizationTokenKey: string

    如您使用的是Auth认证，指定的Auth请求头名称

  • blockSize: number

    分片和计算hash使用的块大小，默认如下，无需更改

  • chunkRetry: number

    最大重试次数

  • chunkSize: number
  • concurrency: number

    并发上传数（块级上传，非必须,默认如下）

  • taskConcurrencyInWorkers: number

    可并发执行任务数（非必须，默认3即可） 此参数主要在worker任务中起作用 基本表示一个worker线程在非忙时可承担的最大任务数 设置大了意义不大

  • apis: object

    api path配置

    • bput: string

      生成块内片服务

    • mkblk: string

      生成文件块服务

    • mkfile: string

      生成文件命令

    • token: string

      获取文件上传token服务

  • clientConfig: object

    服务基础配置

    • baseURL: string

      api 地址配置，默认 api.6pan.cn

    • headers: object

      fetch 上传类型基础配置，默认如下

      • Content-Type: string

Static interceptors

interceptors: { qetag: { request: InterceptorManager<QeTagInterceptor<QeTagConfig>, QeTagReject>; response: InterceptorManager<QeTagInterceptor<QETagBase>, QeTagReject> } } = interceptors
description

内建截断器，准备优化，将上传服务拆出，方便加料

static
memberof

Base

Type declaration

Accessors

statusInfo

  • get statusInfo(): string

Methods

addStatusHandler

  • addStatusHandler(status: STATUS, handler: Function): this

getError

  • getError(): Error[]

isCalculating

  • isCalculating(): boolean

isCancel

  • isCancel(): boolean

isDone

  • isDone(): boolean

isFailed

  • isFailed(): boolean

isPaused

  • isPaused(): boolean

isPending

  • isPending(): boolean

isPreparing

  • isPreparing(): boolean

isTryout

  • isTryout(): boolean

isUploading

  • isUploading(): boolean

markTry

  • markTry(tryNum?: undefined | number): void

  • 标记一次重试

    memberof

    Status

    Parameters

    • Optional tryNum: undefined | number

    Returns void

recordError

  • recordError(e: Error): void

  • 将错误push至错误数组中

    memberof

    Status

    Parameters

    • e: Error

    Returns void

restTryCount

  • restTryCount(): void

setStatus

  • setStatus(status: STATUS): void

Static config

  • config(config: Config | { AuthorizationStorageKey?: Config["AuthorizationStorageKey"]; AuthorizationTokenKey?: Config["AuthorizationTokenKey"]; api?: Config["apis"]; blockSize?: Config["blockSize"]; chunkRetry?: Config["chunkRetry"]; chunkSize?: Config["chunkSize"]; clientConfig?: Config["clientConfig"]; concurrency?: Config["concurrency"]; taskConcurrencyInWorkers?: Config["taskConcurrencyInWorkers"] }): void

  • 设置全局共享的上传配置

    static
    memberof

    Base

    Parameters

    • config: Config | { AuthorizationStorageKey?: Config["AuthorizationStorageKey"]; AuthorizationTokenKey?: Config["AuthorizationTokenKey"]; api?: Config["apis"]; blockSize?: Config["blockSize"]; chunkRetry?: Config["chunkRetry"]; chunkSize?: Config["chunkSize"]; clientConfig?: Config["clientConfig"]; concurrency?: Config["concurrency"]; taskConcurrencyInWorkers?: Config["taskConcurrencyInWorkers"] }

    Returns void

Generated using TypeDoc