ember-cli-storagekit
Version:
A thin layer on top of the HTML5 localStorage and sessionStorage services
597 lines (381 loc) • 17.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>BaseAdapter - ember-cli-storagekit</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="ember-cli-storagekit" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.4.0.9e0c4433</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/BaseAdapter.html">BaseAdapter</a></li>
<li><a href="../classes/BaseStorageService.html">BaseStorageService</a></li>
<li><a href="../classes/InstanceAdapter.html">InstanceAdapter</a></li>
<li><a href="../classes/InstanceStorageService.html">InstanceStorageService</a></li>
<li><a href="../classes/JsonSerializer.html">JsonSerializer</a></li>
<li><a href="../classes/LocalAdapter.html">LocalAdapter</a></li>
<li><a href="../classes/LocalStorageService.html">LocalStorageService</a></li>
<li><a href="../classes/ObjectStorageService.html">ObjectStorageService</a></li>
<li><a href="../classes/SessionAdapter.html">SessionAdapter</a></li>
<li><a href="../classes/StorageService.html">StorageService</a></li>
<li><a href="../classes/StorageSupportUtility.html">StorageSupportUtility</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/adapters.html">adapters</a></li>
<li><a href="../modules/ember-cli-storagekit.html">ember-cli-storagekit</a></li>
<li><a href="../modules/mixins.html">mixins</a></li>
<li><a href="../modules/serializers.html">serializers</a></li>
<li><a href="../modules/services.html">services</a></li>
<li><a href="../modules/utilities.html">utilities</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>BaseAdapter Class</h1>
<div class="box meta">
<div class="uses">
Uses
<ul class="inline commas">
<li><a href="EmberCliStoragekit/Mixins/BuildNamespace.html">EmberCliStoragekit/Mixins/BuildNamespace</a></li>
</ul>
</div>
<div class="extends">
Extends Ember.Object
</div>
<div class="foundat">
Defined in: <a href="../files/addon_adapters_abstract.js.html#l9"><code>addon/adapters/abstract.js:9</code></a>
</div>
Module: <a href="../modules/adapters.html">adapters</a><br>
Parent Module: <a href="../modules/ember-cli-storagekit.html">ember-cli-storagekit</a>
</div>
<div class="box intro">
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method public">
<a href="#method_clear">clear</a>
</li>
<li class="index-item method public">
<a href="#method_getItem">getItem</a>
</li>
<li class="index-item method">
<a href="#method_key">key</a>
</li>
<li class="index-item method public">
<a href="#method_keys">keys</a>
</li>
<li class="index-item method public">
<a href="#method_length">length</a>
</li>
<li class="index-item method public">
<a href="#method_removeItem">removeItem</a>
</li>
<li class="index-item method public">
<a href="#method_setItem">setItem</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property private">
<a href="#property_serializer">serializer</a>
</li>
<li class="index-item property private">
<a href="#property_storage The storage service to delegate to">storage The storage service to delegate to</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_clear" class="method item public">
<h3 class="name"><code>clear</code></h3>
<span class="paren">()</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l83"><code>addon/adapters/abstract.js:83</code></a>
</p>
</div>
<div class="description">
<p>Clears all key/value pairs from storage</p>
</div>
</div>
<div id="method_getItem" class="method item public">
<h3 class="name"><code>getItem</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l42"><code>addon/adapters/abstract.js:42</code></a>
</p>
</div>
<div class="description">
<p>Gets a value from storage based on a given key</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The key to use when retrieving a value from storage</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>The value retrieved from storage based on the given key</p>
</div>
</div>
</div>
<div id="method_key" class="method item">
<h3 class="name"><code>key</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l63"><code>addon/adapters/abstract.js:63</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method_keys" class="method item public">
<h3 class="name"><code>keys</code></h3>
<span class="paren">()</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l70"><code>addon/adapters/abstract.js:70</code></a>
</p>
</div>
<div class="description">
<p>Returns all the keys that are currently in the storage "world" in sorted order
(where the namespace defines the world boundary).</p>
</div>
</div>
<div id="method_length" class="method item public">
<h3 class="name"><code>length</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l92"><code>addon/adapters/abstract.js:92</code></a>
</p>
</div>
<div class="description">
<p>The current length/number of items in storage</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
<p>The number of items in storage</p>
</div>
</div>
</div>
<div id="method_removeItem" class="method item public">
<h3 class="name"><code>removeItem</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l53"><code>addon/adapters/abstract.js:53</code></a>
</p>
</div>
<div class="description">
<p>Removes a value from storage using a given key</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The key/value to remove from storage</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setItem" class="method item public">
<h3 class="name"><code>setItem</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</code>
</li>
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l31"><code>addon/adapters/abstract.js:31</code></a>
</p>
</div>
<div class="description">
<p>Sets a value into storage under a provided key</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The key name to store the given value under</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type"></span>
<div class="param-description">
<p>A value to store under a specified key</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_serializer" class="property item private">
<h3 class="name"><code>serializer</code></h3>
<span class="type"></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l24"><code>addon/adapters/abstract.js:24</code></a>
</p>
</div>
<div class="description">
<p>The serializer to use when storing values into storage</p>
</div>
</div>
<div id="property_storage The storage service to delegate to" class="property item private">
<h3 class="name"><code>storage The storage service to delegate to</code></h3>
<span class="type"></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_adapters_abstract.js.html#l18"><code>addon/adapters/abstract.js:18</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>