mongo-portable
Version:
Portable Pure JS MongoDB - Based on Monglodb (https://github.com/euforic/monglodb.git) by Christian Sullivan (http://RogueSynaptics.com)
963 lines • 85.8 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Cursor | 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="cursor.html">Cursor</a>
</li>
</ul>
<h1>Class Cursor</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Cursor</p>
</div>
<dl class="tsd-comment-tags">
<dt>module</dt>
<dd><p>Cursor</p>
</dd>
<dt>since</dt>
<dd><p>0.0.1</p>
</dd>
<dt>author</dt>
<dd><p>Eduardo Astolfi <a href="mailto:eduardo.astolfi91@gmail.com">eduardo.astolfi91@gmail.com</a></p>
</dd>
<dt>copyright</dt>
<dd><p>2016 Eduardo Astolfi <a href="mailto:eduardo.astolfi91@gmail.com">eduardo.astolfi91@gmail.com</a></p>
</dd>
<dt>license</dt>
<dd><p>MIT Licensed</p>
</dd>
<dt>classdesc</dt>
<dd><p>Cursor class that maps a MongoDB-like cursor</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Cursor</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="cursor.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="cursor.html#cursorposition" class="tsd-kind-icon">cursor<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#dbobjects" class="tsd-kind-icon">db<wbr>Objects</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#documents" class="tsd-kind-icon">documents</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#fetchmode" class="tsd-kind-icon">fetch<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#fields" class="tsd-kind-icon">fields</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#indexes" class="tsd-kind-icon">indexes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#limitvalue" class="tsd-kind-icon">limit<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="cursor.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#selector" class="tsd-kind-icon">selector</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#selectorcompiled" class="tsd-kind-icon">selector<wbr>Compiled</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#selectorid" class="tsd-kind-icon">selector<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#skipvalue" class="tsd-kind-icon">skip<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#sortcompiled" class="tsd-kind-icon">sort<wbr>Compiled</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#sortvalue" class="tsd-kind-icon">sort<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="cursor.html#sorted" class="tsd-kind-icon">sorted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="cursor.html#colscan" class="tsd-kind-icon">COLSCAN</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="cursor.html#idxscan" class="tsd-kind-icon">IDXSCAN</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"><a href="cursor.html#batchsize" class="tsd-kind-icon">batch<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#close" class="tsd-kind-icon">close</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#comment" class="tsd-kind-icon">comment</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#count" class="tsd-kind-icon">count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#explain" class="tsd-kind-icon">explain</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#fetch" class="tsd-kind-icon">fetch</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#fetchall" class="tsd-kind-icon">fetch<wbr>All</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#fetchone" class="tsd-kind-icon">fetch<wbr>One</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#hasnext" class="tsd-kind-icon">has<wbr>Next</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#hint" class="tsd-kind-icon">hint</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#itcount" class="tsd-kind-icon">itcount</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#map" class="tsd-kind-icon">map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#max" class="tsd-kind-icon">max</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#maxscan" class="tsd-kind-icon">max<wbr>Scan</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#maxtimems" class="tsd-kind-icon">max<wbr>TimeMS</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#min" class="tsd-kind-icon">min</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#next" class="tsd-kind-icon">next</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#nocursortimeout" class="tsd-kind-icon">no<wbr>Cursor<wbr>Timeout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#objsleftinbatch" class="tsd-kind-icon">objs<wbr>Left<wbr>InBatch</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#pretty" class="tsd-kind-icon">pretty</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#readconcern" class="tsd-kind-icon">read<wbr>Concern</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#readpref" class="tsd-kind-icon">read<wbr>Pref</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#returnkey" class="tsd-kind-icon">return<wbr>Key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#rewind" class="tsd-kind-icon">rewind</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#setsorting" class="tsd-kind-icon">set<wbr>Sorting</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#showrecordid" class="tsd-kind-icon">show<wbr>Record<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#size" class="tsd-kind-icon">size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#skip" class="tsd-kind-icon">skip</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#snapshot" class="tsd-kind-icon">snapshot</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#sort" class="tsd-kind-icon">sort</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#tailable" class="tsd-kind-icon">tailable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="cursor.html#toarray" class="tsd-kind-icon">to<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="cursor.html#project" class="tsd-kind-icon">project</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="cursor.html#sort-1" class="tsd-kind-icon">sort</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-private"><a href="cursor.html#defaultoptions" class="tsd-kind-icon">default<wbr>Options</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>Cursor<span class="tsd-signature-symbol">(</span>documents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, selection<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>, options<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><a href="cursor.html" class="tsd-signature-type">Cursor</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/collection/Cursor.ts#L65">collection/Cursor.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>documents: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The list of documents</p>
</div>
</div>
</li>
<li>
<h5>selection: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fields: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="cursor.html" class="tsd-signature-type">Cursor</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="cursorposition" class="tsd-anchor"></a>
<h3>cursor<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">cursor<wbr>Position<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/collection/Cursor.ts#L57">collection/Cursor.ts:57</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="dbobjects" class="tsd-anchor"></a>
<h3>db<wbr>Objects</h3>
<div class="tsd-signature tsd-kind-icon">db<wbr>Objects<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/collection/Cursor.ts#L56">collection/Cursor.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="documents" class="tsd-anchor"></a>
<h3>documents</h3>
<div class="tsd-signature tsd-kind-icon">documents<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/collection/Cursor.ts#L44">collection/Cursor.ts:44</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fetchmode" class="tsd-anchor"></a>
<h3>fetch<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">fetch<wbr>Mode<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/collection/Cursor.ts#L53">collection/Cursor.ts:53</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fields" class="tsd-anchor"></a>
<h3>fields</h3>
<div class="tsd-signature tsd-kind-icon">fields<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/collection/Cursor.ts#L46">collection/Cursor.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="indexes" class="tsd-anchor"></a>
<h3>indexes</h3>
<div class="tsd-signature tsd-kind-icon">indexes<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/Cursor.ts#L54">collection/Cursor.ts:54</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="limitvalue" class="tsd-anchor"></a>
<h3>limit<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">limit<wbr>Value<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/collection/Cursor.ts#L48">collection/Cursor.ts:48</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/collection/Cursor.ts#L59">collection/Cursor.ts:59</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="selector" class="tsd-anchor"></a>
<h3>selector</h3>
<div class="tsd-signature tsd-kind-icon">selector<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/collection/Cursor.ts#L45">collection/Cursor.ts:45</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/collection/Cursor.ts#L51">collection/Cursor.ts:51</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="selectorid" class="tsd-anchor"></a>
<h3>selector<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">selector<wbr>Id<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/collection/Cursor.ts#L52">collection/Cursor.ts:52</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="skipvalue" class="tsd-anchor"></a>
<h3>skip<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">skip<wbr>Value<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/collection/Cursor.ts#L47">collection/Cursor.ts:47</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sortcompiled" class="tsd-anchor"></a>
<h3>sort<wbr>Compiled</h3>
<div class="tsd-signature tsd-kind-icon">sort<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/collection/Cursor.ts#L55">collection/Cursor.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sortvalue" class="tsd-anchor"></a>
<h3>sort<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">sort<wbr>Value<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/collection/Cursor.ts#L49">collection/Cursor.ts:49</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sorted" class="tsd-anchor"></a>
<h3>sorted</h3>
<div class="tsd-signature tsd-kind-icon">sorted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/collection/Cursor.ts#L50">collection/Cursor.ts:50</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="colscan" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> COLSCAN</h3>
<div class="tsd-signature tsd-kind-icon">COLSCAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "colscan"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/collection/Cursor.ts#L41">collection/Cursor.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="idxscan" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> IDXSCAN</h3>
<div class="tsd-signature tsd-kind-icon">IDXSCAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "idxscan"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/collection/Cursor.ts#L42">collection/Cursor.ts:42</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">
<a name="batchsize" class="tsd-anchor"></a>
<h3>batch<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">batch<wbr>Size<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/collection/Cursor.ts#L331">collection/Cursor.ts:331</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="close" class="tsd-anchor"></a>
<h3>close</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">close<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/collection/Cursor.ts#L339">collection/Cursor.ts:339</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="comment" class="tsd-anchor"></a>
<h3>comment</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">comment<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/collection/Cursor.ts#L347">collection/Cursor.ts:347</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="count" class="tsd-anchor"></a>
<h3>count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">(</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#L242">collection/Cursor.ts:242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Obtains the total of documents of the cursor</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#count</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>The total of documents in the cursor</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="explain" class="tsd-anchor"></a>
<h3>explain</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">explain<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/collection/Cursor.ts#L355">collection/Cursor.ts:355</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="fetch" class="tsd-anchor"></a>
<h3>fetch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</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#L209">collection/Cursor.ts:209</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias for {@link Cursor#fetchAll}</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#fetch</p>
</dd>
</dl>
</div>
<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="fetchall" class="tsd-anchor"></a>
<h3>fetch<wbr>All</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fetch<wbr>All<span class="tsd-signature-symbol">(</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#L220">collection/Cursor.ts:220</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetch all documents in the cursor</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#fetchAll</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>All the documents contained in the cursor</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="fetchone" class="tsd-anchor"></a>
<h3>fetch<wbr>One</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fetch<wbr>One<span class="tsd-signature-symbol">(</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#L231">collection/Cursor.ts:231</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves the next document in the cursor</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#fetchOne</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>The next document in the cursor</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="foreach" class="tsd-anchor"></a>
<h3>for<wbr>Each</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>callback<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/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/collection/Cursor.ts#L157">collection/Cursor.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Iterates over the cursor, calling a callback function</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#forEach</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <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-method tsd-parent-kind-class">
<a name="hasnext" class="tsd-anchor"></a>
<h3>has<wbr>Next</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<wbr>Next<span class="tsd-signature-symbol">(</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#L191">collection/Cursor.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if the cursor has one document to be fetched</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#hasNext</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if we can fetch one more document</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="hint" class="tsd-anchor"></a>
<h3>hint</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">hint<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/collection/Cursor.ts#L363">collection/Cursor.ts:363</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="itcount" class="tsd-anchor"></a>
<h3>itcount</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">itcount<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/collection/Cursor.ts#L371">collection/Cursor.ts:371</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="limit" class="tsd-anchor"></a>
<h3>limit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">(</span>limit<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">this</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#L320">collection/Cursor.ts:320</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the max number of document to fetch</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#limit</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>limit: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The max number of documents</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p>This instance so it can be chained with other methods</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="map" class="tsd-anchor"></a>
<h3>map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">map<span class="tsd-signature-symbol">(</span>callback<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/collection/Cursor.ts#L174">collection/Cursor.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Iterates over the cursor, returning a new array with the documents affected by the callback function</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#map</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <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>
<p>The documents after being affected with the callback function</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="max" class="tsd-anchor"></a>
<h3>max</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">max<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/collection/Cursor.ts#L395">collection/Cursor.ts:395</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="maxscan" class="tsd-anchor"></a>
<h3>max<wbr>Scan</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">max<wbr>Scan<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/collection/Cursor.ts#L379">collection/Cursor.ts:379</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="maxtimems" class="tsd-anchor"></a>
<h3>max<wbr>TimeMS</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">max<wbr>TimeMS<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/collection/Cursor.ts#L387">collection/Cursor.ts:387</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="min" class="tsd-anchor"></a>
<h3>min</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">min<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/collection/Cursor.ts#L403">collection/Cursor.ts:403</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="next" class="tsd-anchor"></a>
<h3>next</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">(</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#L200">collection/Cursor.ts:200</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias for {@link Cursor#fetchOne}</p>
</div>
<dl class="tsd-comment-tags">
<dt>method</dt>
<dd><p>Cursor#next</p>
</dd>
</dl>
</div>
<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="nocursortimeout" class="tsd-anchor"></a>
<h3>no<wbr>Cursor<wbr>Timeout</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">no<wbr>Cursor<wbr>Timeout<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/collection/Cursor.ts#L411">collection/Cursor.ts:411</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="objsleftinbatch" class="tsd-anchor"></a>
<h3>objs<wbr>Left<wbr>InBatch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">objs<wbr>Left<wbr>InBatch<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/collection/Cursor.ts#L419">collection/Cursor.ts:419</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>todo</dt>
<dd><p>Implement</p>
</dd>
</dl>
</div>
<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-class">
<a name="pretty" class="tsd-anchor"></a>
<h3>pretty</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pretty<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signatu