Numerous Pancakes Munched

    save-as-file
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.0 • Public • Published

    File Saver

    A simple fn to save a file to disk.

    npm GitHub Workflow Status Coveralls github branch

    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.stringify({ping: true});
    const file = new File([json], {type: 'application/json'});
    saveAsFile(file, 'test.json');

    Usage


    ES6

    Save a File to disk:

    import saveFile from 'save-as-file';
    const json = JSON.stringify({ping: true});
    const file = new File([json], {type: 'application/json'});
    saveFile(file, '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:

    import saveFile from 'save-as-file';
    const json = JSON.stringify({ping: true});
    const file = new File([json], {type: 'application/json'});
    saveFile(file, 'test.json', 1000 * 60 * 10 /* 10 mins */);

    CommonJS

    Save a File to disk:

    const saveFile = require('save-as-file');
    const json = JSON.stringify({ping: true});
    const file = new File([json], {type: 'application/json'});
    saveFile(file, '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:

    Install

    npm i save-as-file

    DownloadsWeekly Downloads

    92

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    22.4 kB

    Total Files

    25

    Last publish

    Collaborators

    • rolandjitsu