UNPKG

mutation-summary

Version:
253 lines 10.7 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IQueryValidator | mutation-summary</title> <meta name="description" content="Documentation for mutation-summary"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </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.json" 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">mutation-summary</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> </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="../modules.html">mutation-summary</a> </li> <li> <a href="iqueryvalidator.html">IQueryValidator</a> </li> </ul> <h1>Interface IQueryValidator</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IQueryValidator</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 "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="iqueryvalidator.html#recordpreviousstate" class="tsd-kind-icon">record<wbr>Previous<wbr>State</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="iqueryvalidator.html#validate" class="tsd-kind-icon">validate</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="recordpreviousstate" class="tsd-anchor"></a> <h3>record<wbr>Previous<wbr>State</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">record<wbr>Previous<wbr>State<span class="tsd-signature-symbol">(</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/convergencelabs/mutation-summary/blob/7c78d6f/src/IQueryValidator.ts#L6">IQueryValidator.ts:6</a></li> </ul> </aside> <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-method tsd-parent-kind-interface"> <a name="validate" class="tsd-anchor"></a> <h3>validate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>summary<span class="tsd-signature-symbol">: </span><a href="../classes/summary.html" class="tsd-signature-type" data-tsd-kind="Class">Summary</a><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/convergencelabs/mutation-summary/blob/7c78d6f/src/IQueryValidator.ts#L4">IQueryValidator.ts:4</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>summary: <a href="../classes/summary.html" class="tsd-signature-type" data-tsd-kind="Class">Summary</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum"> <a href="../enums/movement.html" class="tsd-kind-icon">Movement</a> </li> <li class=" tsd-kind-class"> <a href="../classes/childlistchange.html" class="tsd-kind-icon">Child<wbr>List<wbr>Change</a> </li> <li class=" tsd-kind-class"> <a href="../classes/mutationprojection.html" class="tsd-kind-icon">Mutation<wbr>Projection</a> </li> <li class=" tsd-kind-class"> <a href="../classes/mutationsummary.html" class="tsd-kind-icon">Mutation<wbr>Summary</a> </li> <li class=" tsd-kind-class"> <a href="../classes/nodechange.html" class="tsd-kind-icon">Node<wbr>Change</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="../classes/nodemap.html" class="tsd-kind-icon">Node<wbr>Map</a> </li> <li class=" tsd-kind-class"> <a href="../classes/qualifier.html" class="tsd-kind-icon">Qualifier</a> </li> <li class=" tsd-kind-class"> <a href="../classes/selector.html" class="tsd-kind-icon">Selector</a> </li> <li class=" tsd-kind-class"> <a href="../classes/summary.html" class="tsd-kind-icon">Summary</a> </li> <li class=" tsd-kind-class"> <a href="../classes/treechanges.html" class="tsd-kind-icon">Tree<wbr>Changes</a> </li> <li class=" tsd-kind-class"> <a href="../classes/treemirror.html" class="tsd-kind-icon">Tree<wbr>Mirror</a> </li> <li class=" tsd-kind-class"> <a href="../classes/treemirrorclient.html" class="tsd-kind-icon">Tree<wbr>Mirror<wbr>Client</a> </li> <li class=" tsd-kind-interface"> <a href="iattributedata.html" class="tsd-kind-icon">IAttribute<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="imutationsummaryoptions.html" class="tsd-kind-icon">IMutation<wbr>Summary<wbr>Options</a> </li> <li class=" tsd-kind-interface"> <a href="inodedata.html" class="tsd-kind-icon">INode<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-has-type-parameter"> <a href="inumbermap.html" class="tsd-kind-icon">INumber<wbr>Map</a> </li> <li class=" tsd-kind-interface"> <a href="ipositiondata.html" class="tsd-kind-icon">IPosition<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="iquery.html" class="tsd-kind-icon">IQuery</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="iqueryvalidator.html" class="tsd-kind-icon">IQuery<wbr>Validator</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="iqueryvalidator.html#recordpreviousstate" class="tsd-kind-icon">record<wbr>Previous<wbr>State</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="iqueryvalidator.html#validate" class="tsd-kind-icon">validate</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-has-type-parameter"> <a href="istringmap.html" class="tsd-kind-icon">IString<wbr>Map</a> </li> <li class=" tsd-kind-interface"> <a href="itextdata.html" class="tsd-kind-icon">IText<wbr>Data</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-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> </ul> <ul class="tsd-legend"> <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> </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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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> </body> </html>