Class UploadClient

Index

Constructors

Methods

base fromUrl fromUrlStatus getSettings group groupInfo info isReadyPoll multipartComplete multipartStart multipartUpload updateSettings uploadFile uploadFileGroup

Constructors

constructor

new UploadClient(settings: Settings): UploadClient
Parameters
- settings: Settings
Returns UploadClient
- Defined in packages/upload-client/src/UploadClient.ts:44

Methods

base

base(
file: SupportedFileInput,
options?: Partial<BaseOptions>,
): Promise<BaseResponse>
Parameters
- file: SupportedFileInput
- options: Partial<BaseOptions> = {}
Returns Promise<BaseResponse>
- Defined in packages/upload-client/src/UploadClient.ts:56

fromUrl

fromUrl(
sourceUrl: string,
options?: Partial<FromUrlOptions>,
): Promise<FromUrlSuccessResponse>
Parameters
- sourceUrl: string
- options: Partial<FromUrlOptions> = {}
Returns Promise<FromUrlSuccessResponse>
- Defined in packages/upload-client/src/UploadClient.ts:71

fromUrlStatus

fromUrlStatus(
token: string,
options?: Partial<FromUrlStatusOptions>,
): Promise<FromUrlStatusResponse>
Parameters
- token: string
- options: Partial<FromUrlStatusOptions> = {}
Returns Promise<FromUrlStatusResponse>
- Defined in packages/upload-client/src/UploadClient.ts:80

getSettings

getSettings(): Settings
Returns Settings
- Defined in packages/upload-client/src/UploadClient.ts:52

group

group(uuids: string[], options?: Partial<GroupOptions>): Promise<GroupInfo>
Parameters
- uuids: string[]
- options: Partial<GroupOptions> = {}
Returns Promise<GroupInfo>
- Defined in packages/upload-client/src/UploadClient.ts:89

groupInfo

groupInfo(id: string, options?: Partial<GroupInfoOptions>): Promise<GroupInfo>
Parameters
- id: string
- options: Partial<GroupInfoOptions> = {}
Returns Promise<GroupInfo>
- Defined in packages/upload-client/src/UploadClient.ts:98

info

info(uuid: string, options?: Partial<InfoOptions>): Promise<FileInfo>
Parameters
- uuid: string
- options: Partial<InfoOptions> = {}
Returns Promise<FileInfo>
- Defined in packages/upload-client/src/UploadClient.ts:65

isReadyPoll

isReadyPoll(
uuid: string,
options?: Partial<IsReadyPoolOptions>,
): Promise<FileInfo>
Parameters
- uuid: string
- options: Partial<IsReadyPoolOptions> = {}
Returns Promise<FileInfo>
- Defined in packages/upload-client/src/UploadClient.ts:160

multipartComplete

multipartComplete(
uuid: string,
options?: Partial<MultipartCompleteOptions>,
): Promise<FileInfo>
Parameters
- uuid: string
- options: Partial<MultipartCompleteOptions> = {}
Returns Promise<FileInfo>
- Defined in packages/upload-client/src/UploadClient.ts:130

multipartStart

multipartStart(
size: number,
options?: Partial<MultipartStartOptions>,
): Promise<MultipartStartResponse>
Parameters
- size: number
- options: Partial<MultipartStartOptions> = {}
Returns Promise<MultipartStartResponse>
- Defined in packages/upload-client/src/UploadClient.ts:107

multipartUpload

multipartUpload(
    part: Sliceable,
    url: string,
    options?: Partial<MultipartUploadOptions>,
): Promise<MultipartUploadResponse>
Parameters
- part: Sliceable
- url: string
- options: Partial<MultipartUploadOptions> = {}
Returns Promise<MultipartUploadResponse>
- Defined in packages/upload-client/src/UploadClient.ts:116

updateSettings

updateSettings(newSettings: Settings): void
Parameters
- newSettings: Settings
Returns void
- Defined in packages/upload-client/src/UploadClient.ts:48

uploadFile

uploadFile(
data: string | SupportedFileInput,
options?: Partial<FileFromOptions>,
): Promise<UploadcareFile>
Parameters
- data: string | SupportedFileInput
- options: Partial<FileFromOptions> = {}
Returns Promise<UploadcareFile>
- Defined in packages/upload-client/src/UploadClient.ts:142

uploadFileGroup

uploadFileGroup(
data: string[] | SupportedFileInput[],
options?: Partial<FileFromOptions & GroupFromOptions>,
): Promise<UploadcareGroup>
Parameters
- data: string[] | SupportedFileInput[]
- options: Partial<FileFromOptions & GroupFromOptions> = {}
Returns Promise<UploadcareGroup>
- Defined in packages/upload-client/src/UploadClient.ts:151