# Class: HttpServerFileUpload

## vertx-js/http_server_file_upload~ HttpServerFileUpload

#### new HttpServerFileUpload()

Represents an file upload from an HTML FORM.

Source:
  - vertx-js/http_server_file_upload.js, line 31

### Methods

#### charset() → {string}

Source:
  - vertx-js/http_server_file_upload.js, line 184

##### Returns:

the charset for the upload

Type
  string

#### contentTransferEncoding() → {string}

Source:
  - vertx-js/http_server_file_upload.js, line 171

##### Returns:

the contentTransferEncoding for the upload

Type
  string

#### contentType() → {string}

Source:
  - vertx-js/http_server_file_upload.js, line 158

##### Returns:

the content type for the upload

Type
  string

#### endHandler(endHandler) → {HttpServerFileUpload}

##### Parameters:

Name | Type | Description
--- | --- | ---
`endHandler` | function |

Source:
  - vertx-js/http_server_file_upload.js, line 75

##### Returns:

Type
  HttpServerFileUpload

#### exceptionHandler(handler) → {HttpServerFileUpload}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/http_server_file_upload.js, line 43

##### Returns:

Type
  HttpServerFileUpload

#### filename() → {string}

Source:
  - vertx-js/http_server_file_upload.js, line 132

##### Returns:

the filename which was used when upload the file.

Type
  string

#### handler(handler) → {HttpServerFileUpload}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/http_server_file_upload.js, line 59

##### Returns:

Type
  HttpServerFileUpload

#### isSizeAvailable() → {boolean}

Source:
  - vertx-js/http_server_file_upload.js, line 212

##### Returns:

true if the size of the upload can be retrieved via HttpServerFileUpload#size.

Type
  boolean

#### name() → {string}

Source:
  - vertx-js/http_server_file_upload.js, line 145

##### Returns:

the name of the attribute

Type
  string

#### pause() → {HttpServerFileUpload}

Source:
  - vertx-js/http_server_file_upload.js, line 89

##### Returns:

Type
  HttpServerFileUpload

#### resume() → {HttpServerFileUpload}

Source:
  - vertx-js/http_server_file_upload.js, line 103

##### 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:
  - vertx-js/http_server_file_upload.js, line 199

##### 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:
  - vertx-js/http_server_file_upload.js, line 118

##### Returns:

Type
  HttpServerFileUpload