Class: HttpServerFileUpload

vertx-js/http_server_file_upload~ HttpServerFileUpload

new HttpServerFileUpload()

Represents an file upload from an HTML FORM.
Source:

Methods

charset() → {string}

Source:
Returns:
the charset for the upload
Type
string

contentTransferEncoding() → {string}

Source:
Returns:
the contentTransferEncoding for the upload
Type
string

contentType() → {string}

Source:
Returns:
the content type for the upload
Type
string

endHandler(endHandler) → {HttpServerFileUpload}

Parameters:
Name Type Description
endHandler function
Source:
Returns:
Type
HttpServerFileUpload

exceptionHandler(handler) → {HttpServerFileUpload}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
HttpServerFileUpload

filename() → {string}

Source:
Returns:
the filename which was used when upload the file.
Type
string

handler(handler) → {HttpServerFileUpload}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
HttpServerFileUpload

isSizeAvailable() → {boolean}

Source:
Returns:
true if the size of the upload can be retrieved via HttpServerFileUpload#size.
Type
boolean

name() → {string}

Source:
Returns:
the name of the attribute
Type
string

pause() → {HttpServerFileUpload}

Source:
Returns:
Type
HttpServerFileUpload

resume() → {HttpServerFileUpload}

Source:
Returns:
Type
HttpServerFileUpload

size() → {number}

The size of the upload may not be available until it is all read. Check HttpServerFileUpload#isSizeAvailable to determine this
Source:
Returns:
the size of the upload (in bytes)
Type
number

streamToFileSystem(filename) → {HttpServerFileUpload}

Stream the content of this upload to the given file on storage.
Parameters:
Name Type Description
filename string the name of the file
Source:
Returns:
Type
HttpServerFileUpload