Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/haydn/json-api-store. An isomorphic JavaScript library that acts as an in memory data store for JSON API data. particlesystem.com/json-api-store
json-api
Something went wrong. Try again.
72 kB · 1945 lines
HTML
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946<!DOCTYPE html><html><head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../"> <title data-ice="title">Store | API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> </head><body class="layout-container">
<header> <a href="./">Home</a> <a href="identifiers.html">Identifier</a> <a href="source.html">Source</a> <a data-ice="repoURL" href="https://github.com/haydn/json-api-store" class="repo-url-github">Repository</a> <div class="search-box"> <span> <img src="./image/search.png"> <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span> </span> <ul class="search-result"></ul> </div></header>
<nav class="navigation" data-ice="nav"><div data-ice="classWrap"> <h2>Class</h2> <ul> <li data-ice="classDoc"><span><a href="class/src/ajax-adapter.js~AjaxAdapter.html">AjaxAdapter</a></span></li><li data-ice="classDoc"><span><a href="class/src/store.js~Store.html">Store</a></span></li></ul></div>
</nav>
<div class="content" data-ice="content"><div class="header-notice"> <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import Store from '<span><a href="file/src/store.js.html#lineNumber5">json-api-store/src/store.js</a></span>'</code></pre></div> <span data-ice="access">public</span> <span data-ice="kind">class</span> <span data-ice="source">| <span><a href="file/src/store.js.html#lineNumber5">source</a></span></span></div>
<div class="self-detail detail"> <h1 data-ice="name">Store</h1>
</div>
<div data-ice="staticMethodSummary"><h2>Static Method Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Static Public Methods</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#static-method-attr">attr</a></span></span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> </p> </div> <div> <div data-ice="description"><p>Creates a field definition for an attribute.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#static-method-hasMany">hasMany</a></span></span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> </p> </div> <div> <div data-ice="description"><p>Creates a field definition for an has-many relationship.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#static-method-hasOne">hasOne</a></span></span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> </p> </div> <div> <div data-ice="description"><p>Creates a field definition for an has-one relationship.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr></tbody></table></div><div data-ice="constructorSummary"><h2>Constructor Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Constructor</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(adapter: <span>*</span>)</span> </p> </div> <div> </div> </td> <td> </td> </tr></tbody></table></div><div data-ice="memberSummary"><h2>Member Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Members</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-member-observable">observable</a></span></span><span data-ice="signature">: <span>Rx.Observable</span></span> </p> </div> <div> <div data-ice="description"><p>An observable that will emit events when any resource in added, updated</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.6.0</span> </td> </tr></tbody></table></div><div data-ice="methodSummary"><h2>Method Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Methods</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-add">add</a></span></span><span data-ice="signature">(object: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Add an individual resource to the store.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-convert">convert</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span> </p> </div> <div> <div data-ice="description"><p>Converts the given partial into a JSON API compliant representation.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.5.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-create">create</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Attempts to create the resource through the adapter and adds it to the</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.5.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-define">define</a></span></span><span data-ice="signature">(names: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span>, definition: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Defines a type of resource.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.2.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-destroy">destroy</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Attempts to delete the resource through the adapter and removes it from</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.5.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-find">find</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span><span>[]</span></span></span> </p> </div> <div> <div data-ice="description"><p>Find a resource or entire collection of resources.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-load">load</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Attempts to load the resource(s) through the adapter and adds it/them to</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.5.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-off">off</a></span></span><span data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, callback: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>)</span> </p> </div> <div> <div class="deprecated" data-ice="deprecated">this method was deprecated. Use the <code>store.observable</code> property instead of this.</div> <div data-ice="description"><p>Unregister an event listener that was registered with on().</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.4.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-on">on</a></span></span><span data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, callback: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div class="deprecated" data-ice="deprecated">this method was deprecated. Use the <code>store.observable</code> property instead of this.</div> <div data-ice="description"><p>Register an event listener: "added", "updated" or "removed".</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.4.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-push">push</a></span></span><span data-ice="signature">(root: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Add a JSON API response to the store.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-remove">remove</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Remove a resource or collection of resources from the store.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.1.0</span> </td> </tr><tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="name"><span><a href="class/src/store.js~Store.html#instance-method-update">update</a></span></span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Attempts to update the resource through the adapter and updates it in the</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.5.0</span> </td> </tr></tbody></table></div>
<div data-ice="staticMethodDetails"><h2 data-ice="title">Static Public Methods</h2>
<div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="static-method-attr"> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span data-ice="name">attr</span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber16">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Creates a field definition for an attribute.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">name</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Name of the property to map this field from.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">options</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>An options object.</p></td> </tr><tr data-ice="property" data-depth="1"> <td data-ice="name" data-depth="1">options.default</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Default value for this field.</p></td> </tr></tbody> </table></div></div>
<div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tr> <td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td class="return-desc" data-ice="returnDescription"><p>Field definition.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="static-method-hasMany"> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span data-ice="name">hasMany</span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber84">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Creates a field definition for an has-many relationship.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">name</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Name of the property to map this field from.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">options</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>An options object.</p></td> </tr><tr data-ice="property" data-depth="1"> <td data-ice="name" data-depth="1">options.inverse</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Name of the inverse relationship.</p></td> </tr></tbody> </table></div></div>
<div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tr> <td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td class="return-desc" data-ice="returnDescription"><p>Field definition.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="static-method-hasOne"> <span class="access" data-ice="access">public</span> <span data-ice="static">static</span> <span data-ice="name">hasOne</span><span data-ice="signature">(name: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber42">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Creates a field definition for an has-one relationship.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">name</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Name of the property to map this field from.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">options</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>An options object.</p></td> </tr><tr data-ice="property" data-depth="1"> <td data-ice="name" data-depth="1">options.inverse</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Name of the inverse relationship.</p></td> </tr></tbody> </table></div></div>
<div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tr> <td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td class="return-desc" data-ice="returnDescription"><p>Field definition.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div></div><div data-ice="constructorDetails"><h2 data-ice="title">Public Constructors</h2>
<div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-constructor-constructor"> <span class="access" data-ice="access">public</span> <span data-ice="name">constructor</span><span data-ice="signature">(adapter: <span>*</span>)</span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber117">source</a></span></span> </span> </h3>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">adapter</td> <td data-ice="type"><span>*</span></td> <td data-ice="appendix"></td> <td data-ice="description"></td> </tr></tbody> </table></div></div>
</div></div><div data-ice="memberDetails"><h2 data-ice="title">Public Members</h2>
<div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-observable"> <span class="access" data-ice="access">public</span> <span data-ice="name">observable</span><span data-ice="signature">: <span>Rx.Observable</span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.6.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber163">source</a></span></span> </span> </h3>
<div data-ice="description"><p>An observable that will emit events when any resource in added, updatedor removed. The object passed to listeners will be in this format:</p><p><pre class="source-code">{ name: string, type: string, id: string, resource: object }</pre></p>
<p>You can learn more about RxJS observables at the GitHub repo:<a href="https://github.com/Reactive-Extensions/RxJS">https://github.com/Reactive-Extensions/RxJS</a></p></div>
<div data-ice="properties"></div>
<div data-ice="example"> <h4>Example:</h4> <div class="example-doc" data-ice="exampleDoc"> <pre class="prettyprint source-code"><code data-ice="exampleCode">let store = new Store();
store.observable.filter(e => e.name === "added").subscribe(event => { console.log(event.name); // "added" console.log(event.type); // "products" console.log(event.id); // "1" console.log(event.resource); // Map {...}});
store.observable.filter(e => e.name === "updated").subscribe(event => { console.log(event.name); // "updated" console.log(event.type); // "products" console.log(event.id); // "1" console.log(event.resource); // Map {...}});
store.observable.filter(e => e.name === "removed").subscribe(event => { console.log(event.name); // "removed" console.log(event.type); // "products" console.log(event.id); // "1" console.log(event.resource); // null});</code></pre> </div></div>
</div></div><div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
<div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-add"> <span class="access" data-ice="access">public</span> <span data-ice="name">add</span><span data-ice="signature">(object: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber175">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Add an individual resource to the store. This is used internally by the<code>push()</code> method.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">object</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>A JSON API Resource Object to be added. See: <a href="http://jsonapi.org/format/#document-resource-objects">http://jsonapi.org/format/#document-resource-objects</a></p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-convert"> <span class="access" data-ice="access">public</span> <span data-ice="name">convert</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.5.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber209">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Converts the given partial into a JSON API compliant representation.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li><li>nullable: false</li></ul></td> <td data-ice="description"><p>The type of the resource. This can be omitted if the partial includes a type property.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li><li>nullable: false</li></ul></td> <td data-ice="description"><p>The id of the resource. This can be omitted if the partial includes an id property.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">partial</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>The data to convert.</p></td> </tr></tbody> </table></div></div>
<div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tr> <td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></td> <td class="return-desc" data-ice="returnDescription"><p>JSON API version of the object.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-create"> <span class="access" data-ice="access">public</span> <span data-ice="name">create</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.5.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber251">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to create the resource through the adapter and adds it to thestore if successful.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">partial</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Data to create the resource with.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">success</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on success.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">error</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on error.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">context</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Context for the callbacks.</p></td> </tr></tbody> </table></div></div>
<div data-ice="example"> <h4>Example:</h4> <div class="example-doc" data-ice="exampleDoc"> <pre class="prettyprint source-code"><code data-ice="exampleCode">let adapter = new Store.AjaxAdapter();let store = new Store(adpater);store.create("product", { title: "A Book" }, (product) => { console.log(product.title);});</code></pre> </div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-define"> <span class="access" data-ice="access">public</span> <span data-ice="name">define</span><span data-ice="signature">(names: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span>, definition: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.2.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber266">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Defines a type of resource.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">names</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Name(s) of the resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">definition</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>The resource's definition.</p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-destroy"> <span class="access" data-ice="access">public</span> <span data-ice="name">destroy</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.5.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber300">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to delete the resource through the adapter and removes it fromthe store if successful.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>ID of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">success</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on success.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">error</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on error.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">context</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Context for the callbacks.</p></td> </tr></tbody> </table></div></div>
<div data-ice="example"> <h4>Example:</h4> <div class="example-doc" data-ice="exampleDoc"> <pre class="prettyprint source-code"><code data-ice="exampleCode">let adapter = new Store.AjaxAdapter();let store = new Store(adpater);store.destroy("product", "1", () => { console.log("Destroyed!");});</code></pre> </div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-find"> <span class="access" data-ice="access">public</span> <span data-ice="name">find</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span><span>[]</span></span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber320">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Find a resource or entire collection of resources.</p><p>NOTE: If the resource hasn't been loaded via an add() or push() call itwill be automatically created when find is called.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of the resource(s) to find.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>The id of the resource to find. If omitted all resources of the type will be returned.</p></td> </tr></tbody> </table></div></div>
<div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tr> <td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span> | <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span><span>[]</span></span></td> <td class="return-desc" data-ice="returnDescription"><p>Either the resource or an array of resources.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-load"> <span class="access" data-ice="access">public</span> <span data-ice="name">load</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.5.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber372">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to load the resource(s) through the adapter and adds it/them tothe store if successful.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li><li>nullable: false</li></ul></td> <td data-ice="description"><p>ID of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">options</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p><strong>NOT YET IMPLEMENTED</strong> (this will include sorting, filtering and pagination options)</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">success</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on success.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">error</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on error.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">context</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Context for the callbacks.</p></td> </tr></tbody> </table></div></div>
<div data-ice="example"> <h4>Example:</h4> <div class="example-doc" data-ice="exampleDoc"> <pre class="prettyprint source-code"><code data-ice="exampleCode">let adapter = new Store.AjaxAdapter();let store = new Store(adpater);store.load("product", "1", (product) => { console.log(product.title);});</code></pre> </div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-off"> <span class="access" data-ice="access">public</span> <span data-ice="name">off</span><span data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, callback: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.4.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber390">source</a></span></span> </span> </h3>
<div class="deprecated" data-ice="deprecated">this method was deprecated. Use the <code>store.observable</code> property instead of this.</div> <div data-ice="description"><p>Unregister an event listener that was registered with on().</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">event</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Name of the event.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Name of resource to originally passed to on().</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>ID of the resource to originally passed to on().</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">callback</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Function originally passed to on().</p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-on"> <span class="access" data-ice="access">public</span> <span data-ice="name">on</span><span data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, callback: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.4.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber422">source</a></span></span> </span> </h3>
<div class="deprecated" data-ice="deprecated">this method was deprecated. Use the <code>store.observable</code> property instead of this.</div> <div data-ice="description"><p>Register an event listener: "added", "updated" or "removed".</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">event</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Name of the event.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Name of resource to watch.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>ID of the resource to watch.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">callback</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Function to call when the event occurs.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">context</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Context in which to call the callback.</p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-push"> <span class="access" data-ice="access">public</span> <span data-ice="name">push</span><span data-ice="signature">(root: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber463">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Add a JSON API response to the store. This method can be used to handle asuccessful GET or POST response from the server.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">root</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>Top Level Object to push. See: <a href="http://jsonapi.org/format/#document-top-level">http://jsonapi.org/format/#document-top-level</a></p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-remove"> <span class="access" data-ice="access">public</span> <span data-ice="name">remove</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.1.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber482">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Remove a resource or collection of resources from the store.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of the resource(s) to remove.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>The id of the resource to remove. If omitted all resources of the type will be removed.</p></td> </tr></tbody> </table></div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-update"> <span class="access" data-ice="access">public</span> <span data-ice="name">update</span><span data-ice="signature">(type: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, id: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, partial: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, success: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, error: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span>, context: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span> <span class="right-info"> <span class="since" data-ice="since">since 0.5.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber526">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to update the resource through the adapter and updates it in thestore if successful.</p></div>
<div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">type</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Type of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">id</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>ID of resource.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">partial</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>nullable: false</li></ul></td> <td data-ice="description"><p>Data to update the resource with.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">success</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on success.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">error</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Callback on error.</p></td> </tr><tr data-ice="property" data-depth="0"> <td data-ice="name" data-depth="0">context</td> <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"><ul><li>optional</li></ul></td> <td data-ice="description"><p>Context for the callbacks.</p></td> </tr></tbody> </table></div></div>
<div data-ice="example"> <h4>Example:</h4> <div class="example-doc" data-ice="exampleDoc"> <pre class="prettyprint source-code"><code data-ice="exampleCode">let adapter = new Store.AjaxAdapter();let store = new Store(adpater);store.update("product", "1", { title: "foo" }, (product) => { console.log(product.title);});</code></pre> </div></div>
</div></div></div>
<footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.2.6)</span></a></footer>
<script src="script/search_index.js"></script><script src="script/search.js"></script><script src="script/pretty-print.js"></script><script src="script/inherited-summary.js"></script><script src="script/test-summary.js"></script><script src="script/inner-link.js"></script><script src="script/patch-for-local.js"></script></body></html>