Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchProperty

Represents a query search property.

Hierarchy

  • SearchProperty

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

id

id: string

the search property ID

name

name: string

a descriptive name for the property

orderBy

orderBy: boolean

whether the property is sortable

type

the property type

Private valueProvider

valueProvider: IValueProvider

The value provider

values

values: any

the values if any

Methods

findValues

  • findValues(options: any): Promise<any>
  • Hook to gather all the values for this property.

    Parameters

    • options: any

      Some additional options, to for example restrict the values or limit the query.

    Returns Promise<any>

Generated using TypeDoc