Class File

The File interface provides information about files and allows JavaScript to access their content.

Hierarchy

Implements

  • FileLike

Constructors

constructor

Properties

#private #private

Accessors

[toStringTag] lastModified name size type webkitRelativePath

Methods

arrayBuffer slice stream text [hasInstance]

Constructors

constructor

  • new File(fileBits, name, options?): File

  • Creates a new File instance.

    Parameters

    • fileBits: BlobParts

      An Array strings, or ArrayBuffer, ArrayBufferView, Blob objects, or a mix of any of such objects, that will be put inside the File.

    • name: string

      The name of the file.

    • Optional options: FilePropertyBag

      An options object containing optional attributes for the file.

    Returns File

Properties

Private #private

#private: any

Private #private

#private: any

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

lastModified

  • get lastModified(): number

  • Returns number

name

  • get name(): string

  • Returns string

size

  • get size(): number

  • Returns the size of the Blob or File in bytes.

    Returns number

type

  • get type(): string

  • Returns the MIME type of the Blob or File.

    Returns string

webkitRelativePath

  • get webkitRelativePath(): string

  • Returns string

Methods

arrayBuffer

  • arrayBuffer(): Promise<ArrayBuffer>

  • Returns a Promise that resolves with the contents of the blob as binary data contained in an ArrayBuffer.

    Returns Promise<ArrayBuffer>

slice

  • slice(start?, end?, contentType?): Blob

  • Creates and returns a new Blob object which contains data from a subset of the blob on which it's called.

    Parameters

    • Optional start: number

      An index into the Blob indicating the first byte to include in the new Blob. If you specify a negative value, it's treated as an offset from the end of the Blob toward the beginning. For example, -10 would be the 10th from last byte in the Blob. The default value is 0. If you specify a value for start that is larger than the size of the source Blob, the returned Blob has size 0 and contains no data.

    • Optional end: number

      An index into the Blob indicating the first byte that will not be included in the new Blob (i.e. the byte exactly at this index is not included). If you specify a negative value, it's treated as an offset from the end of the Blob toward the beginning. For example, -10 would be the 10th from last byte in the Blob. The default value is size.

    • Optional contentType: string

      The content type to assign to the new Blob; this will be the value of its type property. The default value is an empty string.

    Returns Blob

stream

  • stream(): ReadableStream<Uint8Array>

  • Returns a ReadableStream which upon reading returns the data contained within the Blob.

    Returns ReadableStream<Uint8Array>

text

  • text(): Promise<string>

  • Returns a Promise that resolves with a string containing the contents of the blob, interpreted as UTF-8.

    Returns Promise<string>

Static [hasInstance]

  • [hasInstance](value): value is File

  • Parameters

    • value: unknown

    Returns value is File

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc