mongo-portable

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Selector | Mongo Portable</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">Mongo Portable</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-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="selector.html">Selector</a> </li> </ul> <h1>Class Selector</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">Selector</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="selector.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="selector.html#clauses" class="tsd-kind-icon">clauses</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="selector.html#logger" class="tsd-kind-icon">logger</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="selector.html#selectorcompiled" class="tsd-kind-icon">selector<wbr>Compiled</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="selector.html#agg_field_selector" class="tsd-kind-icon">AGG_<wbr>FIELD_<wbr>SELECTOR</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="selector.html#field_selector" class="tsd-kind-icon">FIELD_<wbr>SELECTOR</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="selector.html#match_selector" class="tsd-kind-icon">MATCH_<wbr>SELECTOR</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="selector.html#sort_selector" class="tsd-kind-icon">SORT_<wbr>SELECTOR</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="selector.html#___buildselector" class="tsd-kind-icon">___build<wbr>Selector</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="selector.html#builddocumentselector" class="tsd-kind-icon">build<wbr>Document<wbr>Selector</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="selector.html#buildkeypathselector" class="tsd-kind-icon">build<wbr>Keypath<wbr>Selector</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="selector.html#compile" class="tsd-kind-icon">compile</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="selector.html#compilefields" class="tsd-kind-icon">compile<wbr>Fields</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="selector.html#compilesort" class="tsd-kind-icon">compile<wbr>Sort</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="selector.html#createclause" class="tsd-kind-icon">create<wbr>Clause</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="selector.html#test" class="tsd-kind-icon">test</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="selector.html#isselectorcompiled" class="tsd-kind-icon">is<wbr>Selector<wbr>Compiled</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="selector.html#matches" class="tsd-kind-icon">matches</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Selector<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<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><a href="selector.html" class="tsd-signature-type">Selector</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L24">selector/Selector.ts:24</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>selector: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = Selector.MATCH_SELECTOR</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="selector.html" class="tsd-signature-type">Selector</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="clauses" class="tsd-anchor"></a> <h3>clauses</h3> <div class="tsd-signature tsd-kind-icon">clauses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L22">selector/Selector.ts:22</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="logger" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3> <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JSWLogger</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L24">selector/Selector.ts:24</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="selectorcompiled" class="tsd-anchor"></a> <h3>selector<wbr>Compiled</h3> <div class="tsd-signature tsd-kind-icon">selector<wbr>Compiled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L21">selector/Selector.ts:21</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="agg_field_selector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> AGG_<wbr>FIELD_<wbr>SELECTOR</h3> <div class="tsd-signature tsd-kind-icon">AGG_<wbr>FIELD_<wbr>SELECTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "project"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L19">selector/Selector.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="field_selector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> FIELD_<wbr>SELECTOR</h3> <div class="tsd-signature tsd-kind-icon">FIELD_<wbr>SELECTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "field"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L18">selector/Selector.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="match_selector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> MATCH_<wbr>SELECTOR</h3> <div class="tsd-signature tsd-kind-icon">MATCH_<wbr>SELECTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "match"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L16">selector/Selector.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="sort_selector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SORT_<wbr>SELECTOR</h3> <div class="tsd-signature tsd-kind-icon">SORT_<wbr>SELECTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "sort"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L17">selector/Selector.ts:17</a></li> </ul> </aside> </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-class tsd-is-private"> <a name="___buildselector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> ___build<wbr>Selector</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">___build<wbr>Selector<span class="tsd-signature-symbol">(</span>selector<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">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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L321">selector/Selector.ts:321</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>selector: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="builddocumentselector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> build<wbr>Document<wbr>Selector</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">build<wbr>Document<wbr>Selector<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L343">selector/Selector.ts:343</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="buildkeypathselector" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> build<wbr>Keypath<wbr>Selector</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">build<wbr>Keypath<wbr>Selector<span class="tsd-signature-symbol">(</span>keypath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L379">selector/Selector.ts:379</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>keypath: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="compile" class="tsd-anchor"></a> <h3>compile</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compile<span class="tsd-signature-symbol">(</span>selector<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><a href="selectormatcher.html" class="tsd-signature-type">SelectorMatcher</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L48">selector/Selector.ts:48</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>selector: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="selectormatcher.html" class="tsd-signature-type">SelectorMatcher</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="compilefields" class="tsd-anchor"></a> <h3>compile<wbr>Fields</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compile<wbr>Fields<span class="tsd-signature-symbol">(</span>spec<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, aggregation<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L222">selector/Selector.ts:222</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>spec: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>aggregation: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="compilesort" class="tsd-anchor"></a> <h3>compile<wbr>Sort</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compile<wbr>Sort<span class="tsd-signature-symbol">(</span>spec<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L100">selector/Selector.ts:100</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>spec: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="createclause" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Clause</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">create<wbr>Clause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L312">selector/Selector.ts:312</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../interfaces/iclause.html" class="tsd-signature-type">IClause</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="test" class="tsd-anchor"></a> <h3>test</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">test<span class="tsd-signature-symbol">(</span>doc<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L44">selector/Selector.ts:44</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>doc: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="isselectorcompiled" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Selector<wbr>Compiled</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>Selector<wbr>Compiled<span class="tsd-signature-symbol">(</span>selector<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">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L471">selector/Selector.ts:471</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>selector: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="matches" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> matches</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">matches<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, doc<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/Selector.ts#L482">selector/Selector.ts:482</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>selector: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>doc: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="selector.html" class="tsd-kind-icon">Selector</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="selector.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="selector.html#clauses" class="tsd-kind-icon">clauses</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="selector.html#logger" class="tsd-kind-icon">logger</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="selector.html#selectorcompiled" class="tsd-kind-icon">selector<wbr>Compiled</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="selector.html#agg_field_selector" class="tsd-kind-icon">AGG_<wbr>FIELD_<wbr>SELECTOR</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="selector.html#field_selector" class="tsd-kind-icon">FIELD_<wbr>SELECTOR</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="selector.html#match_selector" class="tsd-kind-icon">MATCH_<wbr>SELECTOR</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="selector.html#sort_selector" class="tsd-kind-icon">SORT_<wbr>SELECTOR</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="selector.html#___buildselector" class="tsd-kind-icon">___build<wbr>Selector</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="selector.html#builddocumentselector" class="tsd-kind-icon">build<wbr>Document<wbr>Selector</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="selector.html#buildkeypathselector" class="tsd-kind-icon">build<wbr>Keypath<wbr>Selector</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="selector.html#compile" class="tsd-kind-icon">compile</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="selector.html#compilefields" class="tsd-kind-icon">compile<wbr>Fields</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="selector.html#compilesort" class="tsd-kind-icon">compile<wbr>Sort</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="selector.html#createclause" class="tsd-kind-icon">create<wbr>Clause</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="selector.html#test" class="tsd-kind-icon">test</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="selector.html#isselectorcompiled" class="tsd-kind-icon">is<wbr>Selector<wbr>Compiled</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="selector.html#matches" class="tsd-kind-icon">matches</a> </li> </ul> </li> </ul> <ul class="after-current"> </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>