Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SortField

Hierarchy

  • SortField

Hierarchy-Diagram

Index

Constructors

Properties

Methods

Constructors

constructor

  • default/copy constructor.

    Parameters

    • Optional other: SortField

      instance to optionally initialize an independent copy of.

    Returns SortField

Properties

ascending

ascending: boolean

whether to sort ascending (true) or descending (false).

name

name: string

name/path of field to sort by.

Methods

fromJSON

  • parses a JSON literal such as '-rating' into this instance.

    Parameters

    • json: string

      data, such as '-rating'.

    Returns SortField

    this instance.

toJSON

  • toJSON(): string

  • formats a JSON literal such as 'name'.

    Returns string

    JSON literal such as 'name'.

toString

  • toString(): string

  • formats a string such as '+name'.

    Returns string

    such as '+name'.

Generated using TypeDoc