@serenity-is/corelib / Uploader

Class: Uploader

Defined in: src/base/uploader.ts:116

File uploader that handles input change, drag-and-drop, paste, and directory traversal, batching files and uploading each batch via XMLHttpRequest. Supports MIME filtering, progress events, CSRF headers, and custom batch handling.

Constructors

Constructor

new Uploader(opt): Uploader

Defined in: src/base/uploader.ts:125

Creates a new uploader and wires up the configured input and drop zones.

Parameters

opt

UploaderOptions

Uploader configuration; defaults from Uploader.defaults are applied.

Returns

Uploader

Properties

defaults

static defaults: Partial<UploaderOptions>

Defined in: src/base/uploader.ts:182

Default UploaderOptions applied when constructing an instance.

---

requestDefaults

static requestDefaults: Partial<UploaderRequest>

Defined in: src/base/uploader.ts:189

Default UploaderRequest applied when Uploader.uploadBatch is called without explicit request options.

Methods

isMultiple()

isMultiple(): boolean

Defined in: src/base/uploader.ts:197

Whether the uploader is configured for multiple file selection.

Returns

boolean

true if multiple files are allowed.

---

uploadBatch()

uploadBatch(batch, request?): Promise<void>

Defined in: src/base/uploader.ts:397

Uploads a single batch via XMLHttpRequest.

Parameters

batch

UploaderBatch

Batch payload containing FormData and file paths.

request?

UploaderRequest

Optional request overrides merged over Uploader.requestDefaults.

Returns

Promise<void>

---

errorHandler()

static errorHandler(data): void

Defined in: src/base/uploader.ts:519

Default error handler. Logs the exception, surfaces server error messages, and falls back to generic notifications or an iframe dialog for HTML responses.

Parameters

data

UploaderErrorData

Error context for the failed upload.

Returns

void