ember-cli-storagekit
Version:
A thin layer on top of the HTML5 localStorage and sessionStorage services
583 lines (385 loc) • 19 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JsonSerializer - 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>JsonSerializer Class</h1>
<div class="box meta">
<div class="extends">
Extends Ember.Object
</div>
<div class="foundat">
Defined in: <a href="../files/addon_serializers_json.js.html#l12"><code>addon/serializers/json.js:12</code></a>
</div>
Module: <a href="../modules/serializers.html">serializers</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_deserialize">deserialize</a>
</li>
<li class="index-item method public">
<a href="#method_isNamespaced">isNamespaced</a>
</li>
<li class="index-item method public deprecated">
<a href="#method_isNamespacedKey">isNamespacedKey</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method public">
<a href="#method_namespaceKey">namespaceKey</a>
</li>
<li class="index-item method public">
<a href="#method_serialize">serialize</a>
</li>
<li class="index-item method public">
<a href="#method_stripNamespace">stripNamespace</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__namespace">_namespace</a>
</li>
<li class="index-item property">
<a href="#property_namespace">namespace</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_deserialize" class="method item public">
<h3 class="name"><code>deserialize</code></h3>
<span class="paren">()</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_serializers_json.js.html#l28"><code>addon/serializers/json.js:28</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method_isNamespaced" class="method item public">
<h3 class="name"><code>isNamespaced</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"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l66"><code>addon/mixins/build-namespace.js:66</code></a>
</p>
</div>
<div class="description">
<p>Determines whether or not a provided key is namespaced.</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 check the namespace status of.</p>
</div>
</li>
</ul>
</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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
</div>
</div>
</div>
<div id="method_isNamespacedKey" class="method item public deprecated">
<h3 class="name"><code>isNamespacedKey</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"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag deprecated" title="please use #isNamespaced instead.">deprecated</span>
<span class="flag public">public</span>
<div class="meta">
<p>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l77"><code>addon/mixins/build-namespace.js:77</code></a>
</p>
<p>Deprecated: please use #isNamespaced instead.</p>
</div>
<div class="description">
<p>Determines whether or not a provided key is namespaced.</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 check the namespace status of.</p>
</div>
</li>
</ul>
</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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
</div>
</div>
</div>
<div id="method_namespaceKey" class="method item public">
<h3 class="name"><code>namespaceKey</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>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l43"><code>addon/mixins/build-namespace.js:43</code></a>
</p>
</div>
<div class="description">
</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>A key to be namespaced.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_serialize" class="method item public">
<h3 class="name"><code>serialize</code></h3>
<span class="paren">()</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/addon_serializers_json.js.html#l20"><code>addon/serializers/json.js:20</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method_stripNamespace" class="method item public">
<h3 class="name"><code>stripNamespace</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"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l53"><code>addon/mixins/build-namespace.js:53</code></a>
</p>
</div>
<div class="description">
<p>strips the namespace from a namespaced 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>A namespaced key to be stripped</p>
</div>
</li>
</ul>
</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/String" class="crosslink external" target="_blank">String</a></span>:
<p>The key with its namespace removed</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__namespace" class="property item private">
<h3 class="name"><code>_namespace</code></h3>
<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>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l25"><code>addon/mixins/build-namespace.js:25</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_namespace" class="property item">
<h3 class="name"><code>namespace</code></h3>
<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="meta">
<p>Provided by the <a href="../modules/mixins.html">mixins</a> module.</p>
<p>
Defined in
<a href="../files/addon_mixins_build-namespace.js.html#l12"><code>addon/mixins/build-namespace.js:12</code></a>
</p>
</div>
<div class="description">
<p>Namespace to prepend to each stored key, separated by a colon (:).</p>
<p>Ex.</p>
<pre class="code prettyprint"><code class="language-javascript"> 'my-namespace:my-key'
</code></pre>
</div>
<p><strong>Default:</strong> ""</p>
</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>