0.1.1 • Published 6 years ago

dwnld v0.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

dwnld


This is refactored and cleaned up fork of downloadjs with new API and some bugs fixed.

License


Summary

The dwnld() package is used to download files on client side with JavaScript.

Installation via npm

npm install dwnld

Included via AMD

    require(['path/to/file'], function(dwnld) {
        dwnld(data, {fileName, mimeType);
    });

Parameters

  • data - The Blob, File, String, or dataURL containing the soon-to-be File's contents.
  • strFileName - The name of the file to be created. This param is optional. You can specify file's extension in its name if you want or dwnld will do the thing for you.
  • strMimeType - The MIME content-type of the file to download. This param is optional.

Usage with simple link

import dwnld from "dwnld"

const someFileLink = "https://someWebsite.com/somePath/file.pdf?someQuery=true"

dwnld(someFileLink, { fileName: "fileNameToSave" })

Usage with dataURL

import dwnld from "dwnld"

const someDataURL = "data:image/gif;base64,R0lGODlhyAAiALM...DfD0QAADs="

dwnld(someDataURL, { fileName: "fileNameToSave" })

Usage with Blob

import dwnld from "dwnld"

const someBlob = new Blob(["some blob"])

dwnld(someBlob, { fileName: "fileNameToSave.txt" })

Usage with UInt8 Array

import dwnld from "dwnld"

const someStr = "some string"
const array = new Uint8Array(someStr.map(s => s.charCodeAt()))

dwnld(array, { fileName: "fileNameToSave.txt" })

Usage with files

import dwnld from "dwnld"

dwnld("/somefile.png");