Query

Query class is used to construct a query that can be passed to the server to get objects or regions

Implements

• QueryInterface

Index

Constructors

• constructor

Properties

• filterout
• filters
• lastpage
• page
• perpage
• search
• searchFallback
• searchField
• sort
• sortBy
• sortDir
• withSchema

Methods

• clearFilters
• get
• hasFilters
• removeFilter
• requestSchema
• resetFilters
• setFields
• setFilterField
• setFilterOut
• setFilters
• setSearch
• update

Constructors

constructor

• new Query(options?: QueryInterface): Query

• Parameters

  • optionaloptions: QueryInterface

  Returns Query

Properties

optionalfilterout

filterout?: {}

Implementation of QueryInterface.filterout

Type declaration

• [key string]: string | number

optionalfilters

filters?: { regions?: { region_ids: string[]; table_name: string } }

Implementation of QueryInterface.filters

Type declaration

• [key string]: any

• optionalregions?: { region_ids: string[]; table_name: string }

  • region_ids: string[]

  • table_name: string

optionallastpage

lastpage?: boolean

Implementation of QueryInterface.lastpage

optionalpage

page?: number

Implementation of QueryInterface.page

optionalperpage

perpage?: number

Implementation of QueryInterface.perpage

optionalsearch

search?: string

Implementation of QueryInterface.search

optionalsearchFallback

searchFallback?: boolean

Implementation of QueryInterface.searchFallback

optionalsearchField

searchField?: string

Implementation of QueryInterface.searchField

optionalsort

sort?: { field: string; order: string }[]

Implementation of QueryInterface.sort

optionalsortBy

sortBy?: string

Implementation of QueryInterface.sortBy

optionalsortDir

sortDir?: string

Implementation of QueryInterface.sortDir

optionalwithSchema

withSchema?: boolean

Implementation of QueryInterface.withSchema

Methods

clearFilters

• clearFilters(): void

• Returns void

get

• get(): { filterout: {}; filters: { regions?: { region_ids: string[]; table_name: string } }; lastpage: boolean; page: number; perpage: number; search: string; searchFallback: boolean; searchField: string; sort: { field: string; order: string }[] }

• Returns { filterout: {}; filters: { regions?: { region_ids: string[]; table_name: string } }; lastpage: boolean; page: number; perpage: number; search: string; searchFallback: boolean; searchField: string; sort: { field: string; order: string }[] }

  • filterout: {}

    • [key string]: string | number

  • filters: { regions?: { region_ids: string[]; table_name: string } }

    • [key string]: any

    • optionalregions?: { region_ids: string[]; table_name: string }

      • region_ids: string[]

      • table_name: string

  • lastpage: boolean

  • page: number

  • perpage: number

  • search: string

  • searchFallback: boolean

  • searchField: string

  • sort: { field: string; order: string }[]

hasFilters

• hasFilters(): boolean

• Returns boolean

removeFilter

• removeFilter(fieldName: string): void

• Parameters

  • fieldName: string

  Returns void

requestSchema

• requestSchema(requestSchema: boolean): void

• Parameters

  • requestSchema: boolean

  Returns void

resetFilters

• resetFilters(fields?: {}): void

• Parameters

  • optionalfields: {}

  Returns void

setFields

• setFields(fields: any): void

• Parameters

  • fields: any

  Returns void

setFilterField

• setFilterField(field: string, value: string | number): void

• Parameters

  • field: string

  • value: string | number

  Returns void

setFilterOut

• setFilterOut(fields: {}): void

• Parameters

  • fields: {}

  Returns void

setFilters

• setFilters(fields: {}): void

• Parameters

  • fields: {}

  Returns void

setSearch

• setSearch(search: string): void

• Parameters

  • search: string

  Returns void

update

• update(query: QueryInterface): void

• Parameters

  • query: QueryInterface

  Returns void