mongo-portable

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>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> </ul> <h1> Mongo Portable</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"><a href="classes/aggregation.html" class="tsd-kind-icon">Aggregation</a></li> <li class="tsd-kind-class"><a href="classes/basestore.html" class="tsd-kind-icon">Base<wbr>Store</a></li> <li class="tsd-kind-class"><a href="classes/binaryparser.html" class="tsd-kind-icon">Binary<wbr>Parser</a></li> <li class="tsd-kind-class"><a href="classes/binaryparserbuffer.html" class="tsd-kind-icon">Binary<wbr>Parser<wbr>Buffer</a></li> <li class="tsd-kind-class"><a href="classes/collection.html" class="tsd-kind-icon">Collection</a></li> <li class="tsd-kind-class"><a href="classes/connectionhelper.html" class="tsd-kind-icon">Connection<wbr>Helper</a></li> <li class="tsd-kind-class"><a href="classes/cursor.html" class="tsd-kind-icon">Cursor</a></li> <li class="tsd-kind-class"><a href="classes/document.html" class="tsd-kind-icon">Document</a></li> <li class="tsd-kind-class"><a href="classes/eventemitter.html" class="tsd-kind-icon">Event<wbr>Emitter</a></li> <li class="tsd-kind-class"><a href="classes/mongoportable.html" class="tsd-kind-icon">Mongo<wbr>Portable</a></li> <li class="tsd-kind-class"><a href="classes/objectid.html" class="tsd-kind-icon">Object<wbr>Id</a></li> <li class="tsd-kind-class"><a href="classes/options.html" class="tsd-kind-icon">Options</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/selectormatcher.html" class="tsd-kind-icon">Selector<wbr>Matcher</a></li> <li class="tsd-kind-class"><a href="classes/utils.html" class="tsd-kind-icon">Utils</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface"><a href="interfaces/iabstractstore.html" class="tsd-kind-icon">IAbstract<wbr>Store</a></li> <li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/iclause.html" class="tsd-kind-icon">IClause</a></li> <li class="tsd-kind-interface"><a href="interfaces/iconnection.html" class="tsd-kind-icon">IConnection</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#machine_id" class="tsd-kind-icon">MACHINE_<wbr>ID</a></li> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#checkforhexregexp" class="tsd-kind-icon">check<wbr>For<wbr>Hex<wbr>Reg<wbr>Exp</a></li> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#chr" class="tsd-kind-icon">chr</a></li> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#database" class="tsd-kind-icon">database</a></li> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#maxbits" class="tsd-kind-icon">max<wbr>Bits</a></li> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#pid" class="tsd-kind-icon">pid</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#applymodifier" class="tsd-kind-icon">apply<wbr>Modifier</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#docomplexgroup" class="tsd-kind-icon">do<wbr>Complex<wbr>Group</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#dogroup" class="tsd-kind-icon">do<wbr>Group</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#domatch" class="tsd-kind-icon">do<wbr>Match</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#doproject" class="tsd-kind-icon">do<wbr>Project</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#dosinglegroup" class="tsd-kind-icon">do<wbr>Single<wbr>Group</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#dosort" class="tsd-kind-icon">do<wbr>Sort</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#ensurefindparams" class="tsd-kind-icon">ensure<wbr>Find<wbr>Params</a></li> <li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#getdocuments" class="tsd-kind-icon">get<wbr>Documents</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#getobjectsize" class="tsd-kind-icon">get<wbr>Object<wbr>Size</a></li> <li class="tsd-kind-function tsd-is-private tsd-is-not-exported"><a href="globals.html#hassorting" class="tsd-kind-icon">has<wbr>Sorting</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#isvalidhexregexp" class="tsd-kind-icon">is<wbr>Valid<wbr>Hex<wbr>Reg<wbr>Exp</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#mapfields" class="tsd-kind-icon">map<wbr>Fields</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#modify" class="tsd-kind-icon">modify</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testclause" class="tsd-kind-icon">test<wbr>Clause</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testlogicalclause" class="tsd-kind-icon">test<wbr>Logical<wbr>Clause</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testobjectclause" class="tsd-kind-icon">test<wbr>Object<wbr>Clause</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testoperatorclause" class="tsd-kind-icon">test<wbr>Operator<wbr>Clause</a></li> <li class="tsd-kind-function tsd-is-not-exported"><a href="globals.html#testoperatorconstraint" class="tsd-kind-icon">test<wbr>Operator<wbr>Constraint</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#bson_types" class="tsd-kind-icon">BSON_<wbr>TYPES</a></li> <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#groupoperators" class="tsd-kind-icon">group<wbr>Operators</a></li> <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#modifiers" class="tsd-kind-icon">modifiers</a></li> <li class="tsd-kind-object-literal tsd-is-not-exported"><a href="globals.html#stages" class="tsd-kind-icon">stages</a></li> </ul> </section> </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="machine_id" class="tsd-anchor"></a> <h3>MACHINE_<wbr>ID</h3> <div class="tsd-signature tsd-kind-icon">MACHINE_<wbr>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = parseInt(`${Math.random() * 0xFFFFFF}`, 10)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L15">document/ObjectId.ts:15</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Machine id.</p> </div> <p>Create a random 3-byte value (i.e. unique for this process). Other drivers use a md5 of the machine id here, but that would mean an asyc call to gethostname, so we don"t bother.</p> <dl class="tsd-comment-tags"> <dt>ignore</dt> <dd></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="checkforhexregexp" class="tsd-anchor"></a> <h3>check<wbr>For<wbr>Hex<wbr>Reg<wbr>Exp</h3> <div class="tsd-signature tsd-kind-icon">check<wbr>For<wbr>Hex<wbr>Reg<wbr>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = new RegExp("^[0-9a-fA-F]{24}$")</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L18">document/ObjectId.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="chr" class="tsd-anchor"></a> <h3>chr</h3> <div class="tsd-signature tsd-kind-icon">chr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">fromCharCode</span><span class="tsd-signature-symbol"> = String.fromCharCode</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/binary/BinaryParser.ts#L9">binary/BinaryParser.ts:9</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="database" class="tsd-anchor"></a> <h3>database</h3> <div class="tsd-signature tsd-kind-icon">database<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/collection/Collection.ts#L48">collection/Collection.ts:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Collection</p> </div> <dl class="tsd-comment-tags"> <dt>module</dt> <dd><p>Collection</p> </dd> <dt>constructor</dt> <dd></dd> <dt>since</dt> <dd><p>0.0.1</p> </dd> <dt>author</dt> <dd><p>Eduardo Astolfi <a href="mailto:eastolfi91@gmail.com">eastolfi91@gmail.com</a></p> </dd> <dt>copyright</dt> <dd><p>2016 Eduardo Astolfi <a href="mailto:eastolfi91@gmail.com">eastolfi91@gmail.com</a></p> </dd> <dt>license</dt> <dd><p>MIT Licensed</p> </dd> <dt>classdesc</dt> <dd><p>Collection class that maps a MongoDB-like collection</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="maxbits" class="tsd-anchor"></a> <h3>max<wbr>Bits</h3> <div class="tsd-signature tsd-kind-icon">max<wbr>Bits<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></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/binary/BinaryParser.ts#L11">binary/BinaryParser.ts:11</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported"> <a name="pid" class="tsd-anchor"></a> <h3>pid</h3> <div class="tsd-signature tsd-kind-icon">pid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = Math.floor(Math.random() * 100000)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L25">document/ObjectId.ts:25</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported"> <a name="applymodifier" class="tsd-anchor"></a> <h3>apply<wbr>Modifier</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">apply<wbr>Modifier<span class="tsd-signature-symbol">(</span>_docUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, val<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/collection/Collection.ts#L1088">collection/Collection.ts:1088</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_docUpdate: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>key: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>val: <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-function tsd-is-not-exported"> <a name="docomplexgroup" class="tsd-anchor"></a> <h3>do<wbr>Complex<wbr>Group</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Complex<wbr>Group<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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/aggregation/Aggregation.ts#L156">aggregation/Aggregation.ts:156</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-function tsd-is-not-exported"> <a name="dogroup" class="tsd-anchor"></a> <h3>do<wbr>Group</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Group<span class="tsd-signature-symbol">(</span>documents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, groupStage<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">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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/aggregation/Aggregation.ts#L170">aggregation/Aggregation.ts:170</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>documents: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>groupStage: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Object</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="domatch" class="tsd-anchor"></a> <h3>do<wbr>Match</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Match<span class="tsd-signature-symbol">(</span>documents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, matchStage<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/aggregation/Aggregation.ts#L164">aggregation/Aggregation.ts:164</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>documents: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>matchStage: <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-function tsd-is-not-exported"> <a name="doproject" class="tsd-anchor"></a> <h3>do<wbr>Project</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Project<span class="tsd-signature-symbol">(</span>documents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, projectStage<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/aggregation/Aggregation.ts#L192">aggregation/Aggregation.ts:192</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>documents: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>projectStage: <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-function tsd-is-not-exported"> <a name="dosinglegroup" class="tsd-anchor"></a> <h3>do<wbr>Single<wbr>Group</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Single<wbr>Group<span class="tsd-signature-symbol">(</span>groupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, groupStage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, documents<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">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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/aggregation/Aggregation.ts#L95">aggregation/Aggregation.ts:95</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>groupId: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>groupStage: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>documents: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Object</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="dosort" class="tsd-anchor"></a> <h3>do<wbr>Sort</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">do<wbr>Sort<span class="tsd-signature-symbol">(</span>documents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, sortStage<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/aggregation/Aggregation.ts#L160">aggregation/Aggregation.ts:160</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>documents: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>sortStage: <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-function tsd-is-not-exported"> <a name="ensurefindparams" class="tsd-anchor"></a> <h3>ensure<wbr>Find<wbr>Params</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">ensure<wbr>Find<wbr>Params<span class="tsd-signature-symbol">(</span>params<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/collection/Collection.ts#L1363">collection/Collection.ts:1363</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>params: <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-function tsd-is-private tsd-is-not-exported"> <a name="getdocuments" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Documents</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">get<wbr>Documents<span class="tsd-signature-symbol">(</span>cursor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, justOne<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/collection/Cursor.ts#L610">collection/Cursor.ts:610</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Retrieves one or all the documents in the cursor</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>cursor: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The cursor with the documents</p> </div> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> justOne: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> <p>If [justOne=true] returns the next document, otherwise returns all the documents</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported"> <a name="getobjectsize" class="tsd-anchor"></a> <h3>get<wbr>Object<wbr>Size</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">get<wbr>Object<wbr>Size<span class="tsd-signature-symbol">(</span>obj<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">number</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/collection/Collection.ts#L21">collection/Collection.ts:21</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the size of an object.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The object</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>The size of the object</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-private tsd-is-not-exported"> <a name="hassorting" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> has<wbr>Sorting</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-private tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">has<wbr>Sorting<span class="tsd-signature-symbol">(</span>cursor<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/collection/Cursor.ts#L684">collection/Cursor.ts:684</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Checks if a cursor has a sorting defined</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>cursor: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The cursor</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>Whether the cursor has sorting or not</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported"> <a name="isvalidhexregexp" class="tsd-anchor"></a> <h3>is<wbr>Valid<wbr>Hex<wbr>Reg<wbr>Exp</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Hex<wbr>Reg<wbr>Exp<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, len<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/document/ObjectId.ts#L19">document/ObjectId.ts:19</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>str: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> len: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 24</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-function tsd-is-not-exported"> <a name="mapfields" class="tsd-anchor"></a> <h3>map<wbr>Fields</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">map<wbr>Fields<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fields<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/collection/Cursor.ts#L535">collection/Cursor.ts:535</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> <li> <h5>fields: <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-function tsd-is-not-exported"> <a name="modify" class="tsd-anchor"></a> <h3>modify</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">modify<span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, keyparts<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>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, level<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/collection/Collection.ts#L1113">collection/Collection.ts:1113</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>document: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>keyparts: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>key: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> level: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</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-function tsd-is-not-exported"> <a name="testclause" class="tsd-anchor"></a> <h3>test<wbr>Clause</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">test<wbr>Clause<span class="tsd-signature-symbol">(</span>clause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, val<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/SelectorMatcher.ts#L368">selector/SelectorMatcher.ts:368</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>clause: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>val: <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-function tsd-is-not-exported"> <a name="testlogicalclause" class="tsd-anchor"></a> <h3>test<wbr>Logical<wbr>Clause</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">test<wbr>Logical<wbr>Clause<span class="tsd-signature-symbol">(</span>clause<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>, key<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/SelectorMatcher.ts#L470">selector/SelectorMatcher.ts:470</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>clause: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>doc: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>key: <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-function tsd-is-not-exported"> <a name="testobjectclause" class="tsd-anchor"></a> <h3>test<wbr>Object<wbr>Clause</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">test<wbr>Object<wbr>Clause<span class="tsd-signature-symbol">(</span>clause<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>, key<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/SelectorMatcher.ts#L444">selector/SelectorMatcher.ts:444</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>clause: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>doc: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>key: <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-function tsd-is-not-exported"> <a name="testoperatorclause" class="tsd-anchor"></a> <h3>test<wbr>Operator<wbr>Clause</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">test<wbr>Operator<wbr>Clause<span class="tsd-signature-symbol">(</span>clause<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><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/SelectorMatcher.ts#L501">selector/SelectorMatcher.ts:501</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>clause: <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 <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-is-not-exported"> <a name="testoperatorconstraint" class="tsd-anchor"></a> <h3>test<wbr>Operator<wbr>Constraint</h3> <ul class="tsd-signatures tsd-kind-function tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">test<wbr>Operator<wbr>Constraint<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, operatorValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, clauseValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, docVal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, clause<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/SelectorMatcher.ts#L513">selector/SelectorMatcher.ts:513</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>operatorValue: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>clauseValue: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>docVal: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>clause: <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> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-not-exported"> <a name="bson_types" class="tsd-anchor"></a> <h3>BSON_<wbr>TYPES</h3> <div class="tsd-signature tsd-kind-icon">BSON_<wbr>TYPES<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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/SelectorMatcher.ts#L664">selector/SelectorMatcher.ts:664</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="bson_types.types" class="tsd-anchor"></a> <h3>types</h3> <div class="tsd-signature tsd-kind-icon">types<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><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [{ alias: "minKey", number: -1, order: 1, isType: null },{ alias: "null", number: 10, order: 2, isType: null },{ alias: "int", number: 16, order: 3, isType: _.isInteger },{ alias: "long", number: 18, order: 3, isType: _.isNumber },{ alias: "double", number: 1, order: 3, isType: _.isNumber },{ alias: "number", number: null, order: 3, isType: _.isNumber },{ alias: "string", number: 2, order: 4, isType: _.isString },{ alias: "symbol", number: 14, order: 4, isType: _.isSymbol },{ alias: "object", number: 3, order: 5, isType: _.isPlainObject },{ alias: "array", number: 4, order: 6, isType: _.isArray },{ alias: "binData", number: 5, order: 7, isType: null },{ alias: "objectId", number: 7, order: 8, isTypefnc: null },{ alias: "bool", number: 8, order: 9, isType: _.isBoolean },{ alias: "date", number: 9, order: 10, isTypefnc: _.isDate }, // format{ alias: "timestamp", number: 17, order: 11, isType: _.isDate }, // format{ alias: "regex", number: 11, order: 12, isType: _.isRegExp },{ alias: "maxKey", number: 127, order: 13, isType: null }// undefined 6// dbPointer// javascript// javascriptWithScope// function]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/selector/SelectorMatcher.ts#L665">selector/SelectorMatcher.ts:665</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="bson_types.getbyalias" class="tsd-anchor"></a> <h3>get<wbr>ByAlias</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">get<wbr>ByAlias<span class="tsd-signature-symbol">(</span>alias<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/SelectorMatcher.ts#L691">selector/SelectorMatcher.ts:691</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>alias: <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-function tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="bson_types.getbyvalue" class="tsd-anchor"></a> <h3>get<wbr>ByValue</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">get<wbr>ByValue<span class="tsd-signature-symbol">(</span>val<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/Eas