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>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> </ul> <h1> mobx-state-tree-entity</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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 "> <h3>Enumerations</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum"><a href="enums/status.html" class="tsd-kind-icon">Status</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="interfaces/singletonentity.html" class="tsd-kind-icon">Singleton<wbr>Entity</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <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> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#metadata" class="tsd-kind-icon">metadata</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <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> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"> <a name="extractprops" class="tsd-anchor"></a> <h3>Extract<wbr>Props</h3> <div class="tsd-signature tsd-kind-icon">Extract<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ExtractProps<T></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#L16">useSingletonEntityl.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"> <a name="modelpropertydefinitionstoproperties" class="tsd-anchor"></a> <h3>Model<wbr>Property<wbr>Definitions<wbr>ToProperties</h3> <div class="tsd-signature tsd-kind-icon">Model<wbr>Property<wbr>Definitions<wbr>ToProperties<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#L47">useSingletonEntityl.ts:47</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="metadata" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> metadata</h3> <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = types.model('Metadata', {error: types.maybeNull(types.string),isHydrating: types.optional(types.boolean, false),isLoading: types.optional(types.boolean, false),status: types.optional(types.integer, Status.PENDING)}).volatile(() => ({hasHydrated: false})).views(self => ({get isDirty(): boolean {// ephemeral value doesn't match persisted one - model is dirtyconst { value } = getParent(self);const { persistedValue } = getParent(self);return (persistedValue &&value &&JSON.stringify(value) !== JSON.stringify(persistedValue));},get hasError(): boolean {return !!self.error;}}))</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#L20">useSingletonEntityl.ts:20</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="derivemodelfromstate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> derive<wbr>Model<wbr>From<wbr>State</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">derive<wbr>Model<wbr>From<wbr>State<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L85">useSingletonEntityl.ts:85</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>state: <span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported"> <a name="derivetypefromstatekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> derive<wbr>Type<wbr>From<wbr>State<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">derive<wbr>Type<wbr>From<wbr>State<wbr>Key<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IAnyType</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L53">useSingletonEntityl.ts:53</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IAnyType</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"> <a name="usesingletonentity" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Singleton<wbr>Entity</h3> <ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">use<wbr>Singleton<wbr>Entity<P, O, T, I><span class="tsd-signature-symbol">(</span>initialValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">I</span>, endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IOptionalIType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/nosachamos/mobx-state-tree-entity/blob/4bb862e/src/useSingletonEntityl.ts#L105">useSingletonEntityl.ts:105</a></li> </ul> </aside> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>P<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelProperties</span></h4> </li> <li> <h4>O</h4> </li> <li> <h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">O</span><span class="tsd-signature-symbol">></span></h4> </li> <li> <h4>I<span class="tsd-signature-symbol">: </span><a href="globals.html#modelpropertydefinitionstoproperties" class="tsd-signature-type">ModelPropertyDefinitionsToProperties</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>initialValue: <span class="tsd-signature-type">I</span></h5> </li> <li> <h5>endpoint: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IOptionalIType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">IModelType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">_NotCustomized</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals current "> <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> <li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-not-exported"> <a href="interfaces/singletonentity.html" class="tsd-kind-icon">Singleton<wbr>Entity</a> </li> <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>