FileSaver.js

An HTML5 saveAs() FileSaver implementation

File system
eligrey/FileSaver.jsfile-saver

README

If you need to save really large files bigger than the blob's size limitation or don't have
enough RAM, then have a look at the more advanced [StreamSaver.js][7]
that can save data directly to the hard drive asynchronously with the power of the new streams API. That will have
support for progress, cancelation and knowing when it's done writing

FileSaver.js
============

FileSaver.js is the solution to saving files on the client-side, and is perfect for
web apps that generates files on the client, However if the file is coming from the
server we recommend you to first try to use [Content-Disposition][8] attachment response header as it has more cross-browser compatiblity.

Looking for canvas.toBlob() for saving canvases? Check out
[canvas-toBlob.js][2] for a cross-browser implementation.

Supported Browsers

BrowserConstructsFilenamesMaxDependencies
----------------------------------------------------------------
FirefoxBlobYes800None
Firefoxdata:Non/a[Blob.js](https://github.com/eligrey/Blob.js)
ChromeBlobYes[2GB][3]None
ChromeBlobYes[RAM/5][3]None
EdgeBlobYes?None
IEBlobYes600None
OperaBlobYes500None
Operadata:Non/a[Blob.js](https://github.com/eligrey/Blob.js)
SafariBlobNo?None
Safaridata:Non/a[Blob.js](https://github.com/eligrey/Blob.js)
SafariBlobYesn/aNone

Feature detection is possible:

  1. ``` js
  2. try {
  3.     var isFileSaverSupported = !!new Blob;
  4. } catch (e) {}
  5. ```

IE < 10


It is possible to save text files in IE < 10 without Flash-based polyfills.
See [ChenWenBrian and koffsyrup's saveTextAs()](https://github.com/koffsyrup/FileSaver.js#examples) for more details.

Safari 6.1+


Blobs may be opened instead of saved sometimes—you may have to direct your Safari users to manually
press ⌘+S to save the file after it is opened. Using the `application/octet-stream` MIME type to force downloads [can cause issues in Safari](https://github.com/eligrey/FileSaver.js/issues/12#issuecomment-47247096).

iOS


saveAs must be run within a user interaction event such as onTouchDown or onClick; setTimeout will prevent saveAs from triggering. Due to restrictions in iOS saveAs opens in a new window instead of downloading, if you want this fixed please tell Apple how this WebKit bug is affecting you.

Syntax

Import saveAs() from file-saver

  1. ``` js
  2. import { saveAs } from 'file-saver';
  3. ```

  1. ``` js
  2. FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Object { autoBom })
  3. ```

Pass { autoBom: true } if you want FileSaver.js to automatically provide Unicode text encoding hints (see: byte order mark). Note that this is only done if your blob type hascharset=utf-8 set.

Examples

Saving text using require()

  1. ``` js
  2. var FileSaver = require('file-saver');
  3. var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"});
  4. FileSaver.saveAs(blob, "hello world.txt");
  5. ```

Saving text


  1. ``` js
  2. var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"});
  3. FileSaver.saveAs(blob, "hello world.txt");
  4. ```

Saving URLs


  1. ``` js
  2. FileSaver.saveAs("https://httpbin.org/image", "image.jpg");
  3. ```
Using URLs within the same origin will just use a[download].
Otherwise, it will first check if it supports cors header with a synchronous head request.
If it does, it will download the data and save using blob URLs.
If not, it will try to download it using a[download].

The standard W3C File API [Blob][4] interface is not available in all browsers.
[Blob.js][5] is a cross-browser Blob implementation that solves this.

Saving a canvas

  1. ``` js
  2. var canvas = document.getElementById("my-canvas");
  3. canvas.toBlob(function(blob) {
  4.     saveAs(blob, "pretty image.png");
  5. });
  6. ```

Note: The standard HTML5 canvas.toBlob() method is not available in all browsers.
[canvas-toBlob.js][6] is a cross-browser canvas.toBlob() that polyfills this.

Saving File


You can save a File constructor without specifying a filename. If the
file itself already contains a name, there is a hand full of ways to get a file
instance (from storage, file input, new constructor, clipboard event).
If you still want to change the name, then you can change it in the 2nd argument.

  1. ``` js
  2. // Note: Ie and Edge don't support the new File constructor,
  3. // so it's better to construct blobs and use saveAs(blob, filename)
  4. var file = new File(["Hello, world!"], "hello world.txt", {type: "text/plain;charset=utf-8"});
  5. FileSaver.saveAs(file);
  6. ```



Tracking image

  [1]: http://eligrey.com/demos/FileSaver.js/
  [2]: https://github.com/eligrey/canvas-toBlob.js
  [3]: https://bugs.chromium.org/p/chromium/issues/detail?id=375297#c107
  [4]: https://developer.mozilla.org/en-US/docs/DOM/Blob
  [5]: https://github.com/eligrey/Blob.js
  [6]: https://github.com/eligrey/canvas-toBlob.js
  [7]: https://github.com/jimmywarting/StreamSaver.js
  [8]: https://github.com/eligrey/FileSaver.js/wiki/Saving-a-remote-file#using-http-header

Installation

  1. ``` sh
  2. # Basic Node.JS installation
  3. npm install file-saver --save
  4. bower install file-saver
  5. ```

Additionally, TypeScript definitions can be installed via:

  1. ``` sh
  2. # Additional typescript definitions
  3. npm install @types/file-saver --save-dev
  4. ```