Class Transmit

Hierarchy

EventEmitter
- Transmit

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Transmit(options?: Partial<TransmitOptions>): Transmit

Overrides EventEmitter.constructor
- Defined in lib/transmit.ts:67
Parameters
- options: Partial<TransmitOptions> = {}
Returns Transmit

Accessors

aborted

get aborted(): boolean

- Defined in lib/transmit.ts:80
Whether the upload has been aborted.

Returns boolean

finished

get finished(): boolean

- Defined in lib/transmit.ts:87
Whether the upload has been finished.

Returns boolean

manager

get manager(): TransmitManager

- Defined in lib/transmit.ts:94
The transmit manager used for this instance.

Returns TransmitManager

Methods

abort

abort(error?: Error): void

- Defined in lib/transmit.ts:101
Abort the current upload. Emits "aborted" and "done" events.

Parameters
- Optional error: Error
Returns void

parse

parse(req: IncomingMessage): Busboy

- Defined in lib/transmit.ts:132
Parse an incoming request with form data.

Parameters
- req: IncomingMessage
Returns Busboy

parseAsync

parseAsync(req: IncomingMessage): Promise<ParseAsyncResults>

- Defined in lib/transmit.ts:160
Parse an incoming request with form data and return its fields and files. If the request is aborted, all uploaded files will be deleted.

Parameters
- req: IncomingMessage
Returns Promise<ParseAsyncResults>

removeUploadedFiles

removeUploadedFiles(): Promise<void>

- Defined in lib/transmit.ts:117
Delete uploaded files for this request. Useful for cleanup after aborting the upload.

Returns Promise<void>

Generated using TypeDoc