@web-atoms/core-docs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"view-model/AtomViewModel" | @web-atoms/core</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">@web-atoms/core</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> </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="_view_model_atomviewmodel_.html">"view-model/AtomViewModel"</a> </li> </ul> <h1>External module "view-model/AtomViewModel"</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>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-kind-icon">Atom<wbr>View<wbr>Model</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#bindablebroadcast" class="tsd-kind-icon">Bindable<wbr>Broadcast</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#bindablereceive" class="tsd-kind-icon">Bindable<wbr>Receive</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#cachedwatch" class="tsd-kind-icon">Cached<wbr>Watch</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#receive" class="tsd-kind-icon">Receive</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#validate" class="tsd-kind-icon">Validate</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#watch" class="tsd-kind-icon">Watch</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_view_model_atomviewmodel_.html#waitforready" class="tsd-kind-icon">wait<wbr>For<wbr>Ready</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="bindablebroadcast" class="tsd-anchor"></a> <h3>Bindable<wbr>Broadcast</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Bindable<wbr>Broadcast<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>channel<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-symbol">: </span><a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L356">src/view-model/AtomViewModel.ts:356</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>channel: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="bindablereceive" class="tsd-anchor"></a> <h3>Bindable<wbr>Receive</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Bindable<wbr>Receive<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>channel<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-symbol">: </span><a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L338">src/view-model/AtomViewModel.ts:338</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>channel: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="cachedwatch" class="tsd-anchor"></a> <h3>Cached<wbr>Watch</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Cached<wbr>Watch<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, descriptor<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L401">src/view-model/AtomViewModel.ts:401</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cached watch must be used with async getters to avoid reloading of resources unless the properties referenced are changed</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a></h5> <div class="tsd-comment tsd-typography"> <p>ViewModel</p> </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>name of property</p> </div> </li> <li> <h5>descriptor: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>descriptor of property</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="receive" class="tsd-anchor"></a> <h3>Receive</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Receive<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>channel<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-symbol">: </span><a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L316">src/view-model/AtomViewModel.ts:316</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Receive messages for given channel</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>channel: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_view_model_basetypes_.html#viewmodelinitfunc" class="tsd-signature-type">viewModelInitFunc</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="validate" class="tsd-anchor"></a> <h3>Validate</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Validate<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L433">src/view-model/AtomViewModel.ts:433</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a></h5> </li> <li> <h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5> </li> <li> <h5>descriptor: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="watch" class="tsd-anchor"></a> <h3>Watch</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Watch<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L378">src/view-model/AtomViewModel.ts:378</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a></h5> </li> <li> <h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5> </li> <li> <h5>descriptor: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="waitforready" class="tsd-anchor"></a> <h3>wait<wbr>For<wbr>Ready</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">wait<wbr>For<wbr>Ready<span class="tsd-signature-symbol">(</span>vm<span class="tsd-signature-symbol">: </span><a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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/web-atoms/core/blob/8e9453e/src/view-model/AtomViewModel.ts#L54">src/view-model/AtomViewModel.ts:54</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Useful only for Unit testing, this function will await till initialization is complete and all pending functions are executed</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vm: <a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-signature-type">AtomViewModel</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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 "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="_view_model_atomviewmodel_.html">"view-<wbr>model/<wbr>Atom<wbr>View<wbr>Model"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_view_model_atomviewmodel_.atomviewmodel.html" class="tsd-kind-icon">Atom<wbr>View<wbr>Model</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#bindablebroadcast" class="tsd-kind-icon">Bindable<wbr>Broadcast</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#bindablereceive" class="tsd-kind-icon">Bindable<wbr>Receive</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#cachedwatch" class="tsd-kind-icon">Cached<wbr>Watch</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#receive" class="tsd-kind-icon">Receive</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#validate" class="tsd-kind-icon">Validate</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#watch" class="tsd-kind-icon">Watch</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_view_model_atomviewmodel_.html#waitforready" class="tsd-kind-icon">wait<wbr>For<wbr>Ready</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> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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>