Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryTransformer

A query transformer alters a user's search query before executing a search.

Query transformers allow extensions to define new search query operators and syntax, for example, by matching strings in a query (e.g. go.imports:) and replacing them with a regular expression or string.

Hierarchy

  • QueryTransformer

Index

Methods

Methods

transformQuery

  • transformQuery(query: string): string | Promise<string>
  • Transforms a search query into another, valid query. If there are no transformations to be made the original query is returned.

    Parameters

    • query: string

      A search query.

    Returns string | Promise<string>

Generated using TypeDoc