</div></div></article><h3class="sectionHeader">Constructors</h3><articleid="Search.new"data-title="Search.new (constructor)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanclass="constructorIdentifier">new </span><spanid="Search.new"class="member-name methodClicker">Search</span>(<spanclass="sigArgList"></span>)</li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.new"class="ellipsis_description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
</div><h3id="Search.new"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
<li><code>needle</code>: The string or regular expression you're looking for</li>
<li><code>backwards</code>: Whether to search backwards from where cursor currently is. Defaults to <code>false</code>.</li>
<li><code>wrap</code>: Whether to wrap the search back to the beginning when it hits the end. Defaults to <code>false</code>.</li>
<li><code>caseSensitive</code>: Whether the search ought to be case-sensitive. Defaults to <code>false</code>.</li>
<li><code>wholeWord</code>: Whether the search matches only on whole words. Defaults to <code>false</code>.</li>
<li><code>range</code>: The <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> to search within. Set this to <code>null</code> for the whole document</li>
<li><code>regExp</code>: Whether the search is a regular expression or not. Defaults to <code>false</code>.</li>
<li><code>start</code>: The starting <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> or cursor position to begin the search</li>
<li><code>skipCurrent</code>: Whether or not to include the current line in the search. Default to <code>false</code>.</li>
</div></div></div></div></article><h3class="sectionHeader">Methods</h3><articleid="Search.$matchIterator"data-title="Search.$matchIterator (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.$matchIterator"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">$matchIterator</span></span>(<spanclass="sigArgList"><ahref="edit_session.html#EditSession"class="argument methodClicker"title="EditSession (class)"data-id="EditSession">EditSession</a> session</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class="returnType "title="String"data-id="String">String</a></li><liclass="argument-type"><ahref="http://www.nodemanual.org/latest/js_doc/Boolean.html"class="returnType "title="Boolean"data-id="Boolean">Boolean</a></li></ul></li></li></ul><ulclass="metaInfo"><li><spanclass="label internal">Internal</span></li></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.$matchIterator"class="ellipsis_description"></div><h3id="Search.$matchIterator"class="methodToggle methodClicker inactive"> </h3><divclass="description"><h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">session</td><tdclass="argType""><ahref="edit_session.html#EditSession"class=""title="EditSession (class)"data-id="EditSession">EditSession</a></td><tdclass="argDescription ">Required. The session to search with</td></tr></table></div></div></div></div></article><articleid="Search.find"data-title="Search.find (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.find"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">find</span></span>(<spanclass="sigArgList"><ahref="edit_session.html#EditSession"class="argument methodClicker"title="EditSession (class)"data-id="EditSession">EditSession</a> session</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="range.html#Range"class="returnType "title="Range (class)"data-id="Range">Range</a></li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.find"class="ellipsis_description"><p>Searches for <code>options.needle</code>. If found, this method returns the <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
</div><h3id="Search.find"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Searches for <code>options.needle</code>. If found, this method returns the <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">session</td><tdclass="argType""><ahref="edit_session.html#EditSession"class=""title="EditSession (class)"data-id="EditSession">EditSession</a></td><tdclass="argDescription ">Required. The session to search with</td></tr></table></div></div></div></div></article><articleid="Search.findAll"data-title="Search.findAll (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.findAll"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">findAll</span></span>(<spanclass="sigArgList"><ahref="edit_session.html#EditSession"class="argument methodClicker"title="EditSession (class)"data-id="EditSession">EditSession</a> session</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type">[ <ahref="range.html#Range"class="returnType "title="Range (class)"data-id="Range">Range</a> ]</li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.findAll"class="ellipsis_description"><p>Searches for all occurances <code>options.needle</code>. If found, this method returns an array of <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
</div><h3id="Search.findAll"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Searches for all occurances <code>options.needle</code>. If found, this method returns an array of <ahref="range.html#Range"class="link-short"title="Range (class)"data-id="Range">Range</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">session</td><tdclass="argType""><ahref="edit_session.html#EditSession"class=""title="EditSession (class)"data-id="EditSession">EditSession</a></td><tdclass="argDescription ">Required. The session to search with</td></tr></table></div></div></div></div></article><articleid="Search.getOptions"data-title="Search.getOptions (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.getOptions"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">getOptions</span></span>(<spanclass="sigArgList"></span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="http://www.nodemanual.org/latest/js_doc/Object.html"class="returnType "title="Object"data-id="Object">Object</a></li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.getOptions"class="ellipsis_description"><p>Returns an object containing all the search options.</p>
</div><h3id="Search.getOptions"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Returns an object containing all the search options.</p>
</div></div></div></div></article><articleid="Search.replace"data-title="Search.replace (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.replace"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">replace</span></span>(<spanclass="sigArgList"><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class="argument methodClicker"title="String"data-id="String">String</a> input, <ahref="http://www.nodemanual.org/latest/js_doc/String.html"class="argument methodClicker"title="String"data-id="String">String</a> replacement</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class="returnType "title="String"data-id="String">String</a></li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.replace"class="ellipsis_description"><p>Searches for <code>options.needle</code> in <code>input</code>, and, if found, replaces it with <code>replacement</code>.</p>
</div><h3id="Search.replace"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Searches for <code>options.needle</code> in <code>input</code>, and, if found, replaces it with <code>replacement</code>.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">input</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class=""title="String"data-id="String">String</a></td><tdclass="argDescription ">Required. The text to search in</td></tr><trclass="argumentRow "><tdclass="argName ">replacement</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class=""title="String"data-id="String">String</a></td><tdclass="argDescription ">Required. The replacing text</td></tr></table></div></div></div></div></article><articleid="Search.set"data-title="Search.set (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="Search.set"class="member-name methodClicker"><spanclass="sigClassName">Search.</span><spanclass="sigMemberName">set</span></span>(<spanclass="sigArgList"><ahref="http://www.nodemanual.org/latest/js_doc/Object.html"class="argument methodClicker"title="Object"data-id="Object">Object</a> options</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="#Search"class="returnType "title="Search (class)"data-id="Search">Search</a></li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_Search.set"class="ellipsis_description"><p>Sets the search options via the <code>options</code> parameter.</p>
</div><h3id="Search.set"class="methodToggle methodClicker inactive"> </h3><divclass="description"><p>Sets the search options via the <code>options</code> parameter.</p>