Field
Field represents a single ordering field.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Field(
path,desc?):Field
Parameters
Section titled “Parameters”string
boolean = false
Returns
Section titled “Returns”Field
Properties
Section titled “Properties”desc:
boolean
Desc indicates if the ordering of the field is descending.
path:
string
Path is the path of the field, including subfields
Methods
Section titled “Methods”subFields()
Section titled “subFields()”subFields():
string[]
SubFields returns the individual subfields of the field path, including the top-level subfield.
Subfields are specified with a . character, such as foo.bar or address street.
Returns
Section titled “Returns”string[]