offline-handler
Version:
Allow your users to use your website while offline easily
469 lines (143 loc) • 7.23 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: OfflineHandler</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: OfflineHandler</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>OfflineHandler<span class="signature">(ressourceList, serviceWorkerPath<span class="signature-attributes">opt</span>, versionParameter<span class="signature-attributes">opt</span>, clearOldCache<span class="signature-attributes">opt</span>, cacheExternalRequests<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
<div class="class-description">Class used to setup the offline access</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="OfflineHandler"><span class="type-signature"></span>new OfflineHandler<span class="signature">(ressourceList, serviceWorkerPath<span class="signature-attributes">opt</span>, versionParameter<span class="signature-attributes">opt</span>, clearOldCache<span class="signature-attributes">opt</span>, cacheExternalRequests<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Creates an OfflineHandler instance
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ressourceList</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">List of request paths to cache</td>
</tr>
<tr>
<td class="name"><code>serviceWorkerPath</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
OfflineHandler-sw.min.js
</td>
<td class="description last">Path to the OfflineHandler-sw.min.js file</td>
</tr>
<tr>
<td class="name"><code>versionParameter</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
v
</td>
<td class="description last">Cache version URL parameter</td>
</tr>
<tr>
<td class="name"><code>clearOldCache</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">Clear the old versions of the files once a new one is registered ?</td>
</tr>
<tr>
<td class="name"><code>cacheExternalRequests</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">Cache requests external to the current domain ?</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="OfflineHandler.js.html">OfflineHandler.js</a>, <a href="OfflineHandler.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="version"><span class="type-signature"></span>version<span class="type-signature"> :String</span></h4>
<div class="description">
Files current version
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="OfflineHandler.js.html">OfflineHandler.js</a>, <a href="OfflineHandler.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="OfflineHandler.html">OfflineHandler</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 21 2018 09:29:06 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>