Searches for options.needle
. If found, this method returns the Range
where the text first occurs. If options.backwards
is true
, the search goes backwards in the session.
The session to search with
Searches for all occurrances options.needle
. If found, this method returns an array of Range
s where the text first occurs. If options.backwards
is true
, the search goes backwards in the session.
The session to search with
[Returns an object containing all the search options.]{: #Search.getOptions}
Searches for options.needle
in input
, and, if found, replaces it with replacement
.
The text to search in
The replacing text
options.regExp
is true
, this function returns input
with the replacement already made. Otherwise, this function just returns replacement
.options.needle
was not found, this function returns null
.Sets the search options via the options
parameter.
An object containing all the new search properties
Sets the search options via the options
parameter.
Generated using TypeDoc
Creates a new
Search
object. The following search options are available:needle
: The string or regular expression you're looking forbackwards
: Whether to search backwards from where cursor currently is. Defaults tofalse
.wrap
: Whether to wrap the search back to the beginning when it hits the end. Defaults tofalse
.caseSensitive
: Whether the search ought to be case-sensitive. Defaults tofalse
.wholeWord
: Whether the search matches only on whole words. Defaults tofalse
.range
: The Range to search within. Set this tonull
for the whole documentregExp
: Whether the search is a regular expression or not. Defaults tofalse
.start
: The starting Range or cursor position to begin the searchskipCurrent
: Whether or not to include the current line in the search. Default tofalse
.