js-file-download

What is js-file-download?

The js-file-download npm package is a simple utility for triggering file downloads in the browser. It allows developers to programmatically download files of various types, such as text, JSON, CSV, and more, directly from the client-side JavaScript code.

What are js-file-download's main functionalities?

Download Text File

This feature allows you to download a plain text file. The code sample demonstrates how to create a text file with the content 'Hello, world!' and trigger a download with the filename 'hello.txt'.

const fileDownload = require('js-file-download');
const text = 'Hello, world!';
fileDownload(text, 'hello.txt');

Download JSON File

This feature allows you to download a JSON file. The code sample shows how to convert a JavaScript object to a JSON string and trigger a download with the filename 'data.json'.

const fileDownload = require('js-file-download');
const jsonData = { name: 'John', age: 30 };
fileDownload(JSON.stringify(jsonData), 'data.json');

Download CSV File

This feature allows you to download a CSV file. The code sample demonstrates how to create a CSV string and trigger a download with the filename 'data.csv'.

const fileDownload = require('js-file-download');
const csvData = 'name,age\nJohn,30\nJane,25';
fileDownload(csvData, 'data.csv');

Other packages similar to js-file-download

file-saver

The file-saver package is a well-known library for saving files on the client-side. It provides similar functionality to js-file-download, allowing you to save text, JSON, CSV, and other types of files. It is widely used and has a larger community and more frequent updates compared to js-file-download.

browser-filesaver

The browser-filesaver package is another alternative for saving files in the browser. It offers similar capabilities to js-file-download, enabling the download of various file types. It is designed to be lightweight and easy to use, making it a good choice for simple file download tasks.

downloadjs

The downloadjs package is a utility for downloading files in the browser. It provides similar functionality to js-file-download, allowing you to trigger downloads of different file types. It is known for its simplicity and ease of integration into web applications.

README

Javascript File Download

Javascript function to trigger browser to save data to file as if it was downloaded.

Installation

npm install js-file-download --save

Usage

var fileDownload = require('js-file-download');
fileDownload(data, 'filename.csv');