Skip to content

remix/form-data-parser · Class

View Source

FileUpload

Summary

A file that was uploaded as part of a multipart/form-data request.

Signature

class FileUpload {
  constructor(part: MultipartPart, fieldName: string): FileUpload

  // Properties
  fieldName: string
  lastModified: number
  name: string
  size: number
  type: string
  webkitRelativePath: string

  // Methods
  arrayBuffer(): Promise<ArrayBuffer>
  bytes(): Promise<Uint8Array<ArrayBuffer>>
  slice(start: number, end: number, contentType: string): Blob
  stream(): ReadableStream<Uint8Array<ArrayBuffer>>
  text(): Promise<string>
}

Properties

fieldName

The name of the <input> field used to upload the file.

lastModified

The lastModified read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.

MDN Reference

name

The name read-only property of the File interface returns the name of the file represented by a File object. For security reasons, the path is excluded from this property.

MDN Reference

size

The size read-only property of the Blob interface returns the size of the Blob or File in bytes.

MDN Reference

type

The type read-only property of the Blob interface returns the MIME type of the file.

MDN Reference

webkitRelativePath

The webkitRelativePath read-only property of the File interface contains a string which specifies the file's path relative to the directory selected by the user in an element with its webkitdirectory attribute set.

MDN Reference

Methods

arrayBuffer(): Promise<ArrayBuffer>

The arrayBuffer() method of the Blob interface returns a Promise that resolves with the contents of the blob as binary data contained in an ArrayBuffer.

MDN Reference

bytes(): Promise<Uint8Array<ArrayBuffer>>

The bytes() method of the Blob interface returns a Promise that resolves with a Uint8Array containing the contents of the blob as an array of bytes.

MDN Reference

slice(start: number, end: number, contentType: string): Blob

The slice() method of the Blob interface creates and returns a new Blob object which contains data from a subset of the blob on which it's called.

MDN Reference

stream(): ReadableStream<Uint8Array<ArrayBuffer>>

The stream() method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the Blob.

MDN Reference

text(): Promise<string>

The text() method of the Blob interface returns a Promise that resolves with a string containing the contents of the blob, interpreted as UTF-8.

MDN Reference