Class Search

constructor

• new Search(): Search

• Returns Search

$options

$assembleMultilineRegExp

• $assembleMultilineRegExp(needle, modifier): false | RegExp[]

• Parameters

  • needle: string

  • modifier: string

  Returns false | RegExp[]

$assembleRegExp

• $assembleRegExp(options, $disableFakeMultiline?): any

• Parameters

  • options: Partial<SearchOptions>

  • Optional $disableFakeMultiline: boolean

  Returns any

$matchIterator

• $matchIterator(session, options): false | {
      forEach: ((callback) => void);
  }

• Parameters

  • session: EditSession

  • options: any

  Returns false | {
      forEach: ((callback) => void);
  }

find

• find(session): false | Range

• Searches for options.needle. If found, this method returns the [[Range Range]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

  Parameters

  • session: EditSession

    The session to search with

  Returns false | Range

findAll

• findAll(session): Range[]

• Searches for all occurrances options.needle. If found, this method returns an array of [[Range Ranges]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

  Parameters

  • session: EditSession

    The session to search with

  Returns Range[]

getOptions

• getOptions(): Partial<SearchOptions>

• [Returns an object containing all the search options.]{: #Search.getOptions}

  Returns Partial<SearchOptions>

replace

• replace(input, replacement): string

• Searches for options.needle in input, and, if found, replaces it with replacement.

  Parameters

  • input: string

    The text to search in

  • replacement: any

    The replacing text

    • (String): If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
      If options.needle was not found, this function returns null.

  Returns string

set

• set(options): Search

• Sets the search options via the options parameter.

  Parameters

  • options: Partial<SearchOptions>

    An object containing all the new search properties

  Returns Search

  Chainable

setOptions

• setOptions(options): void

• Sets the search options via the options parameter.

  Parameters

  • options: Partial<SearchOptions>

    object containing all the search propertie

  Returns void

  Related

  Search.set