Class HttpServerFileUpload

Represents an file upload from an HTML FORM.

Hierarchy

HttpServerFileUpload

Implements

ReadStream<Buffer>

Index

Methods

Methods

cancelStreamToFileSystem

cancelStreamToFileSystem(): boolean

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4632
Try to cancel the file system streaming, the streamed file will be deleted.

Returns boolean

charset

charset(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4652
Returns string

contentTransferEncoding

contentTransferEncoding(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4648
Returns string

contentType

contentType(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4644
Returns string

endHandler

endHandler(endHandler: ((res: void) => void) | Handler<void> | null | undefined): HttpServerFileUpload

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4611
Parameters
- endHandler: ((res: void) => void) | Handler<void> | null | undefined
Returns HttpServerFileUpload

exceptionHandler

exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): HttpServerFileUpload

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4607
Parameters
- handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined
Returns HttpServerFileUpload

fetch

fetch(amount: number): HttpServerFileUpload

Implementation of ReadStream.fetch
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4617
Parameters
- amount: number
Returns HttpServerFileUpload

file

file(): AsyncFile

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4666
Returns AsyncFile

filename

filename(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4636
Returns string

handler

handler(handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined): HttpServerFileUpload

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4609
Parameters
- handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined
Returns HttpServerFileUpload

isSizeAvailable

isSizeAvailable(): boolean

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4662
Returns boolean

name

name(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4640
Returns string

pause

pause(): HttpServerFileUpload

Implementation of ReadStream.pause
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4613
Returns HttpServerFileUpload

pipe

pipe(): Pipe<Buffer>

Implementation of ReadStream.pipe
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4585
Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.

Returns Pipe<Buffer>

pipeTo

pipeTo(dst: WriteStream<Buffer>): PromiseLike<void>
pipeTo(dst: WriteStream<Buffer>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

Implementation of ReadStream.pipeTo
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4595
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<Buffer>
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4605
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<Buffer>
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

resume

resume(): HttpServerFileUpload

Implementation of ReadStream.resume
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4615
Returns HttpServerFileUpload

size

size(): number

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4658
The size of the upload may not be available until it is all read. Check {@link HttpServerFileUpload#isSizeAvailable} to determine this

Returns number

streamToFileSystem

streamToFileSystem(filename: string): PromiseLike<void>
streamToFileSystem(filename: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4622
Stream the content of this upload to the given file on storage.

Parameters
- filename: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4627
Stream the content of this upload to the given file on storage.

Parameters
- filename: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

Generated using TypeDoc