file-saver vs js-file-download vs downloadjs
JavaScript File Download Libraries Comparison
1 Year
file-saverjs-file-downloaddownloadjsSimilar Packages:
What's JavaScript File Download Libraries?

JavaScript file download libraries simplify the process of triggering file downloads in web applications. They provide developers with tools to create and manage file downloads directly from the browser, enhancing user experience by allowing seamless data export and file handling. These libraries support various file types and offer different methods for generating and saving files, making them essential for applications that require user-generated content or data export functionalities.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
file-saver3,452,51721,783-2114 years agoMIT
js-file-download653,598923-105 years agoMIT
downloadjs328,7802,300-498 years agoMIT
Feature Comparison: file-saver vs js-file-download vs downloadjs

File Type Support

  • file-saver:

    FileSaver.js is designed to handle various file types, including images, text files, and binary data. It provides built-in support for different MIME types, ensuring that files are saved correctly across different browsers.

  • js-file-download:

    js-file-download supports common file types such as text and JSON, and it allows for easy customization of file names and types during the download process, making it suitable for straightforward applications.

  • downloadjs:

    Download.js supports a wide range of file types, including text, JSON, and binary files. It allows developers to easily specify the file type and name during the download process, making it versatile for different use cases.

Browser Compatibility

  • file-saver:

    FileSaver.js offers extensive browser compatibility, including support for Internet Explorer and other older browsers. This makes it a reliable choice for applications that need to cater to a wider audience with varying browser versions.

  • js-file-download:

    js-file-download is primarily optimized for modern browsers and may have limited support for older versions. It's best suited for applications targeting users with up-to-date browsers.

  • downloadjs:

    Download.js is built with a focus on modern browsers and has good compatibility with most major browsers. However, it may not support older browsers as effectively, so testing is recommended for legacy systems.

Ease of Use

  • file-saver:

    FileSaver.js provides a straightforward API but may require more configuration compared to Download.js. It is still user-friendly, especially for developers familiar with handling file downloads in JavaScript.

  • js-file-download:

    js-file-download is designed for simplicity, offering an easy-to-use interface that allows developers to trigger downloads quickly. It is particularly beneficial for those who prioritize ease of integration.

  • downloadjs:

    Download.js features a simple and intuitive API that allows developers to implement file downloads with minimal setup. This makes it an excellent choice for quick projects or prototypes where speed is essential.

Customization Options

  • file-saver:

    FileSaver.js offers robust customization options, including the ability to specify MIME types and file names, making it suitable for applications that require precise control over the download process.

  • js-file-download:

    js-file-download provides basic customization options, allowing developers to set file names and types easily, but it does not offer as many advanced features as FileSaver.js.

  • downloadjs:

    Download.js allows for some customization regarding file names and types, but it is more focused on providing a quick solution rather than extensive configuration options.

Community and Maintenance

  • file-saver:

    FileSaver.js has a larger community and is widely used, which means there are more resources, tutorials, and community support available. It is also actively maintained, ensuring compatibility with new browser versions.

  • js-file-download:

    js-file-download has a smaller user base, which may limit community resources. It is maintained but may not receive updates as frequently as FileSaver.js.

  • downloadjs:

    Download.js has a smaller community compared to the other libraries, which may affect the availability of resources and support. However, it is actively maintained and updated.

How to Choose: file-saver vs js-file-download vs downloadjs
  • file-saver:

    Select FileSaver.js if you require robust support for saving files on the client side with a focus on compatibility across different browsers. It is ideal for applications that need to handle complex file types and provides more control over the download process, including MIME type handling.

  • js-file-download:

    Opt for js-file-download if you want a straightforward and easy-to-use library that focuses on file downloads with a minimal setup. It is particularly useful for projects where simplicity and ease of use are prioritized, allowing for quick integration.

  • downloadjs:

    Choose Download.js if you need a lightweight solution that supports a variety of file types and offers a simple API for triggering downloads without additional dependencies. It is particularly useful for quick implementations where minimal configuration is desired.

README for file-saver

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 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 attachment response header as it has more cross-browser compatiblity.

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

Supported Browsers

| Browser | Constructs as | Filenames | Max Blob Size | Dependencies | | -------------- | ------------- | ------------ | ------------- | ------------ | | Firefox 20+ | Blob | Yes | 800 MiB | None | | Firefox < 20 | data: URI | No | n/a | Blob.js | | Chrome | Blob | Yes | 2GB | None | | Chrome for Android | Blob | Yes | RAM/5 | None | | Edge | Blob | Yes | ? | None | | IE 10+ | Blob | Yes | 600 MiB | None | | Opera 15+ | Blob | Yes | 500 MiB | None | | Opera < 15 | data: URI | No | n/a | Blob.js | | Safari 6.1+* | Blob | No | ? | None | | Safari < 6 | data: URI | No | n/a | Blob.js | | Safari 10.1+   | Blob         | Yes         | n/a           | None |

Feature detection is possible:

try {
    var isFileSaverSupported = !!new Blob;
} catch (e) {}

IE < 10

It is possible to save text files in IE < 10 without Flash-based polyfills. See ChenWenBrian and koffsyrup's saveTextAs() 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.

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

import { saveAs } from 'file-saver';
FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Object { autoBom })

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 has charset=utf-8 set.

Examples

Saving text using require()

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

Saving text

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

Saving URLs

FileSaver.saveAs("https://httpbin.org/image", "image.jpg");

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 interface is not available in all browsers. Blob.js is a cross-browser Blob implementation that solves this.

Saving a canvas

var canvas = document.getElementById("my-canvas");
canvas.toBlob(function(blob) {
    saveAs(blob, "pretty image.png");
});

Note: The standard HTML5 canvas.toBlob() method is not available in all browsers. canvas-toBlob.js 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.

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

Tracking image

Installation

# Basic Node.JS installation
npm install file-saver --save
bower install file-saver

Additionally, TypeScript definitions can be installed via:

# Additional typescript definitions
npm install @types/file-saver --save-dev