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.
73 kB · 2133 lines
HTML
at master
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134<!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>
<div data-ice="functionWrap"> <h2><a href="function/">Function</a></h2> <ul> <li data-ice="functionDoc"><span><a href="function/index.html#static-function-ajax">ajax</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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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> </p> </div> <div> <div data-ice="description"><p>Finds a resource by type and id.</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-findAll">findAll</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>): <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>Finds all the resources of a given type.</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.7.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>): <span>Rx.Observable</span></span> </p> </div> <div> <div data-ice="description"><p>Attempts to load the given 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-loadAll">loadAll</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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</span></span> </p> </div> <div> <div data-ice="description"><p>Attempts to load all the resources of the given type through the adapter</p></div> </div> </td> <td> <span class="since" data-ice="since">since 0.7.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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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#lineNumber250">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">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>Options to pass to the adapter.</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>Rx.Observable</span></td> </tr> </table> <div data-ice="returnProperties"></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" }).subscribe((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#lineNumber265">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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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#lineNumber298">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">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>Options to pass to the adapter.</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>Rx.Observable</span></td> </tr> </table> <div data-ice="returnProperties"></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").subscribe(() => { 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 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#lineNumber317">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Finds a resource by type and id.</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 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>nullable: false</li></ul></td> <td data-ice="description"><p>The id of the resource to find.</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>The resource.</p></td> </tr> </table> <div data-ice="returnProperties"></div> </div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-findAll"> <span class="access" data-ice="access">public</span> <span data-ice="name">findAll</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>): <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.7.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber364">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Finds all the resources of a given type.</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 to find.</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><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>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>): <span>Rx.Observable</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#lineNumber398">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to load the given 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">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">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>Options to pass to the adapter.</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>Rx.Observable</span></td> </tr> </table> <div data-ice="returnProperties"></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("products", "1").subscribe((product) => { console.log(product.title);});</code></pre> </div></div>
</div><div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-loadAll"> <span class="access" data-ice="access">public</span> <span data-ice="name">loadAll</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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</span></span> <span class="right-info"> <span class="since" data-ice="since">since 0.7.0</span> <span data-ice="source"><span><a href="file/src/store.js.html#lineNumber430">source</a></span></span> </span> </h3>
<div data-ice="description"><p>Attempts to load all the resources of the given type through the adapterand adds them to the 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">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>Options to pass to the adapter.</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>Rx.Observable</span></td> </tr> </table> <div data-ice="returnProperties"></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.loadAll("products").subscribe((products) => { console.log(products);});</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#lineNumber448">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#lineNumber482">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#lineNumber525">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#lineNumber544">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>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span>Rx.Observable</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#lineNumber587">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">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>Options to pass to the adapter.</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>Rx.Observable</span></td> </tr> </table> <div data-ice="returnProperties"></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" }).subscribe((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>