Class Search

constructor

• new Search(): Search

  Returns Search

$options

$assembleMultilineRegExp

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

  Parameters

  • needle: string
  • modifier: string

  Returns false | RegExp[]

$assembleRegExp

• $assembleRegExp(
      options: Partial<Ace.SearchOptions>,
      $disableFakeMultiline?: boolean,
  ): any

  Parameters

  • options: Partial<Ace.SearchOptions>
  • Optional$disableFakeMultiline: boolean

  Returns any

$isMultilineSearch

• $isMultilineSearch(options: any): boolean

  Parameters

  • options: any

  Returns boolean

$matchIterator

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

  Parameters

  • session: EditSession
  • options: any

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

$multiLineBackward

• $multiLineBackward(
      session: any,
      re: any,
      endIndex: any,
      start: any,
      first: any,
  ): { endCol: any; endRow: number; startCol: any; startRow: any }

  Parameters

  • session: any
  • re: any
  • endIndex: any
  • start: any
  • first: any

  Returns { endCol: any; endRow: number; startCol: any; startRow: any }

$multiLineForward

• $multiLineForward(
      session: any,
      re: any,
      start: any,
      last: any,
  ): { endCol: any; endRow: number; startCol: any; startRow: number }

  Parameters

  • session: any
  • re: any
  • start: any
  • last: any

  Returns { endCol: any; endRow: number; startCol: any; startRow: number }

find

• find(session: EditSession): 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: EditSession): 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<Ace.SearchOptions>

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

  Returns Partial<Ace.SearchOptions>

parseReplaceString

• parseReplaceString(replaceString: any): any

  Parameters

  • replaceString: any

  Returns any

replace

• replace(input: string, replacement: any): 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: Partial<Ace.SearchOptions>): Search

  Sets the search options via the options parameter.

  Parameters

  • options: Partial<Ace.SearchOptions>

    An object containing all the new search properties

  Returns Search

  Chainable

setOptions

• setOptions(options: Partial<Ace.SearchOptions>): void

  Sets the search options via the options parameter.

  Parameters

  • options: Partial<Ace.SearchOptions>

    object containing all the search propertie

  Returns void

  Related

  Search.set