documon
Version:
A documentation system for mortals. Use with any language.
328 lines (165 loc) • 8.94 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Storage</title>
<meta name="description" content="Set/Get convienence methods for localStorage.">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "gieson.Storage",
name: "Storage"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="gieson.Storage"></a><a name="Storage"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
Storage ()
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Storage.js</span>
<span class="member-line-number">16</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">gieson.Storage<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/template/assets/js/documon/Storage.js<span></div>
</div>
<p>Set/Get convienence methods for localStorage.</p>
</div>
</div>
</div>
</div>
<div class="parts">
<a name="methods"></a>
<div class="part-methods">
<div class="heading-part">Methods</div>
<a name="gieson.Storage.getStore"></a><a name="getStore"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
getStore (<span class="method-arguments">name</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Storage.js</span>
<span class="member-line-number">44</span>
</span>
</div>
<div class="member-description">
<p>Retrieves an item from browser's local storage.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">name</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The name of the "thing" you want to get.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">any</span>
</div>
<div class="member"><p>The stored data</p></div>
</div>
</div>
<a name="gieson.Storage.setStore"></a><a name="setStore"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
setStore (<span class="method-arguments">name</span>, <span class="method-arguments">val</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Storage.js</span>
<span class="member-line-number">26</span>
</span>
</div>
<div class="member-description">
<p>Stores data. Can store string, number, boolean and objects.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">name</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The name of the "thing" to store. (We use this to get it out later)</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">val</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">any</span>
<div class="member-description">
<p>The actual thing to store.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>