ContextQMD
Back to Content

FileReader

files/en-us/web/api/filereader/index.md

latest5.9 KB
Original Source

{{APIRef("File API")}}{{AvailableInWorkers}}

The FileReader interface lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using {{domxref("File")}} or {{domxref("Blob")}} objects to specify the file or data to read.

File objects may be obtained from a {{domxref("FileList")}} object returned as a result of a user selecting files using the <input type="file"> element, or from a drag and drop operation's {{domxref("DataTransfer")}} object. FileReader can only access the contents of files that the user has explicitly selected; it cannot be used to read a file by pathname from the user's file system. To read files on the client's file system by pathname, use the File System Access API. To read server-side files, use {{domxref("Window/fetch", "fetch()")}}, with CORS permission if reading cross-origin.

{{InheritanceDiagram}}

Constructor

  • {{domxref("FileReader.FileReader", "FileReader()")}}
    • : Returns a new FileReader object.

See Using files from web applications for details and examples.

Instance properties

  • {{domxref("FileReader.error")}} {{ReadOnlyInline}}

    • : A {{domxref("DOMException")}} representing the error that occurred while reading the file.

  • {{domxref("FileReader.readyState")}} {{ReadOnlyInline}}

    • : A number indicating the state of the FileReader. This is one of the following:

      NameValueDescription
      EMPTY0No data has been loaded yet.
      LOADING1Data is currently being loaded.
      DONE2The entire read request has been completed.

  • {{domxref("FileReader.result")}} {{ReadOnlyInline}}

    • : The file's contents. This property is only valid after the read operation is complete, and the format of the data depends on which of the methods was used to initiate the read operation.

Instance methods

  • {{domxref("FileReader.abort()")}}
    • : Aborts the read operation. Upon return, the readyState will be DONE.
  • {{domxref("FileReader.readAsArrayBuffer()")}}
    • : Starts reading the contents of the specified {{domxref("Blob")}}, once finished, the result attribute contains an {{jsxref("ArrayBuffer")}} representing the file's data.
  • {{domxref("FileReader.readAsBinaryString()")}} {{deprecated_inline}}
    • : Starts reading the contents of the specified {{domxref("Blob")}}, once finished, the result attribute contains the raw binary data from the file as a string.
  • {{domxref("FileReader.readAsDataURL()")}}
    • : Starts reading the contents of the specified {{domxref("Blob")}}, once finished, the result attribute contains a data: URL representing the file's data.
  • {{domxref("FileReader.readAsText()")}}
    • : Starts reading the contents of the specified {{domxref("Blob")}}, once finished, the result attribute contains the contents of the file as a text string. An optional encoding name can be specified.

Events

Listen to these events using {{domxref("EventTarget/addEventListener", "addEventListener()")}} or by assigning an event listener to the oneventname property of this interface. Remove the event listeners with {{domxref("EventTarget.removeEventListener", "removeEventListener()")}}, once FileReader is no longer used, to avoid memory leaks.

  • {{domxref("FileReader/abort_event", "abort")}}
    • : Fired when a read has been aborted, for example because the program called {{domxref("FileReader.abort()")}}.
  • {{domxref("FileReader/error_event", "error")}}
    • : Fired when the read failed due to an error.
  • {{domxref("FileReader/load_event", "load")}}
    • : Fired when a read has completed successfully.
  • {{domxref("FileReader/loadend_event", "loadend")}}
    • : Fired when a read has completed, successfully or not.
  • {{domxref("FileReader/loadstart_event", "loadstart")}}
    • : Fired when a read has started.
  • {{domxref("FileReader/progress_event", "progress")}}
    • : Fired periodically as data is read.

Examples

Using FileReader

This example reads and displays the contents of a text file directly in the browser.

HTML

html
<h1>File Reader</h1>
<input type="file" id="file-input" />
<div id="message"></div>
<pre id="file-content"></pre>

JavaScript

js
const fileInput = document.getElementById("file-input");
const fileContentDisplay = document.getElementById("file-content");
const messageDisplay = document.getElementById("message");

fileInput.addEventListener("change", handleFileSelection);

function handleFileSelection(event) {
  const file = event.target.files[0];
  fileContentDisplay.textContent = ""; // Clear previous file content
  messageDisplay.textContent = ""; // Clear previous messages

  // Validate file existence and type
  if (!file) {
    showMessage("No file selected. Please choose a file.", "error");
    return;
  }

  if (!file.type.startsWith("text")) {
    showMessage("Unsupported file type. Please select a text file.", "error");
    return;
  }

  // Read the file
  const reader = new FileReader();
  reader.onload = () => {
    fileContentDisplay.textContent = reader.result;
  };
  reader.onerror = () => {
    showMessage("Error reading the file. Please try again.", "error");
  };
  reader.readAsText(file);
}

// Displays a message to the user
function showMessage(message, type) {
  messageDisplay.textContent = message;
  messageDisplay.style.color = type === "error" ? "red" : "green";
}

Result

{{EmbedLiveSample("Using FileReader", 640, 300)}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also