File Saver
A simple fn to save a file to disk.
Table of Contents
Installation
You can install this package from NPM:
npm add save-as-file
Or with Yarn:
yarn add save-as-file
CDN
For CDN, you can use unpkg:
https://unpkg.com/save-as-file/dist/bundles/save-as-file.umd.min.js
The global namespace for save-as-file is saveAsFile
:
const json = JSON;const file = json type: 'application/json';;
Usage
ES6
Save a File to disk:
;;;saveFilefile, 'test.json';
NOTE: We create a temporary data uri for File/Blob objects which we revoke after 1 minute. If you need to download a large file which may take longer than 1 minute to download, use the 3rd argument to increase this timeout:
;;;saveFilefile, 'test.json', 1000 * 60 * 10 /* 10 mins */;
CommonJS
Save a File to disk:
;;;saveFilefile, 'test.json';
Browser Support
You can expect this lib to run wherever the href download attribute is supported.
Contribute
If you wish to contribute, please use the following guidelines:
- Use Conventional Commits
- Use
[ci skip]
in commit messages to skip a build