mobx-state-tree-entity

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SingletonEntity | mobx-state-tree-entity</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">mobx-state-tree-entity</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="singletonentity.html">SingletonEntity</a> </li> </ul> <h1>Interface SingletonEntity<V></h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>V</h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">SingletonEntity</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-not-exported"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="singletonentity.html#isdirty" class="tsd-kind-icon">is<wbr>Dirty</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="singletonentity.html#metadata" class="tsd-kind-icon">metadata</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="singletonentity.html#persistedvalue" class="tsd-kind-icon">persisted<wbr>Value</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="singletonentity.html#value" class="tsd-kind-icon">value</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="isdirty" class="tsd-anchor"></a> <h3>is<wbr>Dirty</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Dirty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L196">useSingletonEntityl.ts:196</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="metadata" class="tsd-anchor"></a> <h3>metadata</h3> <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L197">useSingletonEntityl.ts:197</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5>has<wbr>Loaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>is<wbr>Dirty<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>is<wbr>Hydrating<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>is<wbr>Loading<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>status<span class="tsd-signature-symbol">: </span><a href="../enums/status.html" class="tsd-signature-type">Status</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="persistedvalue" class="tsd-anchor"></a> <h3>persisted<wbr>Value</h3> <div class="tsd-signature tsd-kind-icon">persisted<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">V</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L195">useSingletonEntityl.ts:195</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="value" class="tsd-anchor"></a> <h3>value</h3> <div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">V</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L194">useSingletonEntityl.ts:194</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum"> <a href="../enums/status.html" class="tsd-kind-icon">Status</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-has-type-parameter tsd-is-not-exported"> <a href="singletonentity.html" class="tsd-kind-icon">Singleton<wbr>Entity</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="singletonentity.html#isdirty" class="tsd-kind-icon">is<wbr>Dirty</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="singletonentity.html#metadata" class="tsd-kind-icon">metadata</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="singletonentity.html#persistedvalue" class="tsd-kind-icon">persisted<wbr>Value</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="singletonentity.html#value" class="tsd-kind-icon">value</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-has-type-parameter"> <a href="../globals.html#extractprops" class="tsd-kind-icon">Extract<wbr>Props</a> </li> <li class=" tsd-kind-type-alias tsd-has-type-parameter"> <a href="../globals.html#modelpropertydefinitionstoproperties" class="tsd-kind-icon">Model<wbr>Property<wbr>Definitions<wbr>ToProperties</a> </li> <li class=" tsd-kind-variable tsd-is-not-exported"> <a href="../globals.html#metadata" class="tsd-kind-icon">metadata</a> </li> <li class=" tsd-kind-function"> <a href="../globals.html#derivemodelfromstate" class="tsd-kind-icon">derive<wbr>Model<wbr>From<wbr>State</a> </li> <li class=" tsd-kind-function tsd-is-not-exported"> <a href="../globals.html#derivetypefromstatekey" class="tsd-kind-icon">derive<wbr>Type<wbr>From<wbr>State<wbr>Key</a> </li> <li class=" tsd-kind-function tsd-has-type-parameter"> <a href="../globals.html#usesingletonentity" class="tsd-kind-icon">use<wbr>Singleton<wbr>Entity</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>