docs/index.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>async-file-dl</title>
<meta name="description" content="Documentation for async-file-dl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">async-file-dl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>async-file-dl</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#async-file-dl" id="async-file-dl" style="color: inherit; text-decoration: none;">
<h1>async-file-dl</h1>
</a>
<p><a href="https://travis-ci.org/OpenByteDev/async-file-dl"><img src="https://travis-ci.org/OpenByteDev/async-file-dl.svg?branch=master" alt="Build Status"></a>
<a href="https://www.npmjs.com/package/async-file-dl"><img src="https://badge.fury.io/js/async-file-dl.svg" alt="npm version"></a>
<a href="https://codeclimate.com/github/OpenByteDev/async-file-dl/maintainability"><img src="https://api.codeclimate.com/v1/badges/79490a06fbe1b1ae1dfb/maintainability" alt="Maintainability"></a>
<a href="https://david-dm.org/OpenByteDev/async-file-dl"><img src="https://david-dm.org/OpenByteDev/async-file-dl/status.svg" alt="Dependency Status"></a>
<a href="https://david-dm.org/OpenByteDev/async-file-dl?type=dev"><img src="https://david-dm.org/OpenByteDev/async-file-dl/dev-status.svg" alt="DevDependency Status"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="License"></a>
<a href=""><img src="https://img.shields.io/badge/doge-wow-yellow.svg" alt="Doge"></a></p>
<p>A simple asynchronous file downloader based on axios.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h3>Installation</h3>
</a>
<pre><code class="language-bash"><span style="color: #000000">$ npm install async-file-dl</span>
</code></pre>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h3>Usage</h3>
</a>
<pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">download</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'async-file-dl'</span><span style="color: #000000">);</span>
<span style="color: #795E26">download</span><span style="color: #000000">(</span><span style="color: #A31515">'http://example.com/'</span><span style="color: #000000">, </span><span style="color: #A31515">'.'</span><span style="color: #000000">, </span><span style="color: #A31515">'example.html'</span><span style="color: #000000">)</span>
<span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">file</span><span style="color: #000000"> </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">'download successful'</span><span style="color: #000000">)</span>
<span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #001080">error</span><span style="color: #000000">);</span>
</code></pre>
<a href="#api" id="api" style="color: inherit; text-decoration: none;">
<h3>API</h3>
</a>
<p>The API generated with <a href="http://typedoc.org/">TypeDoc</a> can be found <a href="https://openbytedev.github.io/async-file-dl/">here</a>.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface">
<a href="interfaces/axiosrequestconfigwithurl.html" class="tsd-kind-icon">Axios<wbr>Request<wbr>Config<wbr>With<wbr>Url</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#defaultconfig" class="tsd-kind-icon">default<wbr>Config</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#download" class="tsd-kind-icon">download</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>