Skip to main content

Interface: UploadOptions

Defined in: packages/client/src/modules/file/types.ts:28

Properties​

apiPath?​

optional apiPath?: string

Defined in: packages/client/src/modules/file/types.ts:37

Defaults to upload_file.


deadline?​

optional deadline?: number

Defined in: packages/client/src/modules/file/types.ts:33

Hard wall-clock deadline, including any ReadableStream buffering before upload.


filename?​

optional filename?: string

Defined in: packages/client/src/modules/file/types.ts:39

Filename sent to the server. Inferred from a File's .name when omitted.


headers?​

optional headers?: Record<string, string>

Defined in: packages/client/src/modules/file/types.ts:34


onProgress?​

optional onProgress?: (progress) => void

Defined in: packages/client/src/modules/file/types.ts:29

Parameters​

progress​

UploadProgressEvent

Returns​

void


requestId?​

optional requestId?: string

Defined in: packages/client/src/modules/file/types.ts:35


signal?​

optional signal?: AbortSignal

Defined in: packages/client/src/modules/file/types.ts:30


timeout?​

optional timeout?: number

Defined in: packages/client/src/modules/file/types.ts:31