browser-file-downloader v0.0.1

Browser File Download

Download files with javascript

import axios from "axios";
import { download } from "browser-file-downloader";

const download = async (url: string, filename: string) => {
  const { data } = await axios.get(url, {
    responseType: "blob",
  });
  download(data, { filename });
};

Options

interface DownloadOptions {
  filename: string; // filename
  mime?: string; // mime time (default: application/octet-stream) - required when using useDataUrl
  bom?: BlobPart; // bom (bytes to include at the start of the file)
  useDataUrl?: boolean; // whether to use the legacy data url instead of a blob url
}

Examples

CSV

If your CSVs are looking weird, you can try

import { download } from "browser-file-downloader";

let csvString = "";
const bom = "\uFEFF";

download(csvString, { filename: "data.csv", bom, useDataUrl: true, mime: "text/csv; charset=utf-8" });

Legacy

const download = require("browser-file-downloader/dist/cjs/index.legacy.js");

download("My data", { filename: "file.txt" });

Modern ESM

import { download } from "browser-file-downloader/dist/mjs/index.modern.js";

download("My data", { filename: "file.txt" });