Interface UploadChunkRequestOptions

Description

This interface shows the minimum data needed to create a single chunk upload request

Export

Interface

UploadChunkRequestOptions

Hierarchy

Properties

action? data failureCb? fallbackProperties? key? progressCb? query? successCb?

Properties

Optional action

action?: string

data

data: {
    blobStorageProviderName: string;
    chunkBlob: Blob;
    chunkOrdinal: number;
    chunkSize: number;
    chunkedFileUploadSessionId: string;
    fileMimeType: string;
    fileName: string;
    numberOfChunks: number;
    positionOfChunkInQueue?: number;
}

Description

the data needed to construct the request

Memberof

UploadChunkRequestOptions

Type declaration

  • blobStorageProviderName: string

    Description

    the target blob storage provider's name

  • chunkBlob: Blob

    Description

    The chunk data

  • chunkOrdinal: number

    Description

    the chunk's ordinal

  • chunkSize: number

    Description

    the chunk size in bytes

  • chunkedFileUploadSessionId: string

    Description

    the current chunk upload session Id

  • fileMimeType: string

    Description

    the file's mime type

  • fileName: string

    Description

    the file's name

  • numberOfChunks: number

    Description

    the total number of chunks

  • Optional positionOfChunkInQueue?: number

    Description

    Optional. The position of the chunk in the request queue, this property is used to calculate the progress of the upload

Optional failureCb

failureCb?: Function

Optional fallbackProperties

fallbackProperties?: string[]

Optional key

key?: string | number

Optional progressCb

progressCb?: Function

Optional query

query?: Query

Optional successCb

successCb?: Function

Settings

Member Visibility

Theme

Generated using TypeDoc