Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchQuery

Provides the ability to specify the query for a search query.

Hierarchy

Index

Constructors

constructor

  • Parameters

    • data: any

    Returns SearchQuery

Properties

Protected _data

_data: any

Methods

toJSON

  • toJSON(): any
  • Returns any

Static boolean

Static booleanField

Static conjuncts

  • Creates a ConjunctionSearchQuery from a set of other SearchQuery's.

    deprecated

    Use the multi-argument overload instead.

    Parameters

    Returns ConjunctionSearchQuery

  • Creates a ConjunctionSearchQuery from a set of other SearchQuery's.

    Parameters

    Returns ConjunctionSearchQuery

Static dateRange

Static disjuncts

  • Creates a DisjunctionSearchQuery from a set of other SearchQuery's.

    deprecated

    Use the multi-argument overload instead.

    Parameters

    Returns DisjunctionSearchQuery

  • Creates a DisjunctionSearchQuery from a set of other SearchQuery's.

    Parameters

    Returns DisjunctionSearchQuery

Static docIds

  • Creates a DocIdSearchQuery from a set of document-ids.

    deprecated

    Use the multi-argument overload instead.

    Parameters

    • queries: string[]

    Returns DocIdSearchQuery

  • Creates a DocIdSearchQuery from a set of document-ids.

    Parameters

    • Rest ...queries: string[]

    Returns DocIdSearchQuery

Static geoBoundingBox

  • Parameters

    • tl_lon: number
    • tl_lat: number
    • br_lon: number
    • br_lat: number

    Returns GeoBoundingBoxSearchQuery

Static geoDistance

  • Parameters

    • lon: number
    • lat: number
    • distance: number

    Returns GeoDistanceSearchQuery

Static geoPolygon

Static match

  • Parameters

    • match: string

    Returns MatchSearchQuery

Static matchAll

Static matchNone

Static matchPhrase

Static numericRange

Static phrase

  • Parameters

    • terms: string[]

    Returns PhraseSearchQuery

Static prefix

  • Parameters

    • prefix: string

    Returns PrefixSearchQuery

Static queryString

Static regexp

  • Parameters

    • regexp: string

    Returns RegexpSearchQuery

Static term

  • Parameters

    • term: string

    Returns TermSearchQuery

Static wildcard

Generated using TypeDoc