Introduction

File Downloader JS is a simple package that allows you to download a file from the browser

Install with npm

1npm install file-downloader-js --save

Install with yarn

1yarn add file-downloader-js

Basic usage

Binary download using fetch

1import fileDownloader from "file-downloader-js";
2
3function download(url: string, filename: string) {
4  fetch(url)
5    .then((res) => res.blob())
6    .then((blob) => {
7      fileDownloader(blob, filename);
8    });
9}

Binary download using axios

1import fileDownloader from "file-downloader-js";
2import Axios from "axios";
3
4function download(url: string, filename: string) {
5  Axios.get(url, {
6    responseType: "blob"
7  }).then((res) => {
8    fileDownloader(res.data, filename);
9  }
10}

CSV Data download example

1import fileDownloader from "file-downloader-js";
2    
3let dataRecords = [
4  ["ID", "Name", "Age"],
5  [1, "Nour", 34],
6  [2, "Mila", 1]
7];
8let data = dataRecords.map((record) => record.join(",")).join("\r\n");
9let filename = "data.csv";
10let mime = "text/csv";
11let bom = new Uint8Array([0xef, 0xbb, 0xbf]);
12
13fileDownloader(data, filename, mime, bom);

License

MIT