Class SyntaxAbstract

constructor

• new Syntax(): Ordering.Syntax

• Returns Ordering.Syntax

Readonly Abstract kind

[cmb]

• [cmb](this, that): Ordering

• If this and that Ordering are Equal, return Equal; otherwise, return the first non-Equal.

  Parameters

  • this: Ordering

  • that: Ordering

  Returns Ordering

[cmp]

• [cmp](this, that): Ordering

• Compare this and that Ordering to determine their ordering.

  Parameters

  • this: Ordering

  • that: Ordering

  Returns Ordering

  Remarks

  When ordered, Less compares as less than Equal which compares as less than Greater.

[eq]

• [eq](this, that): boolean

• Compare this and that Ordering to determine their equality.

  Parameters

  • this: Ordering

  • that: Ordering

  Returns boolean

  Remarks

  Two Ordering are equal if they are the same variant.

isEq

• isEq(this): this is Equal

• Test whether this Ordering is Equal.

  Parameters

  • this: Ordering

  Returns this is Equal

isGe

• isGe(this): this is Equal | Greater

• Test whether this Ordering is Greater or Equal.

  Parameters

  • this: Ordering

  Returns this is Equal | Greater

isGt

• isGt(this): this is Greater

• Test whether this Ordering is Greater.

  Parameters

  • this: Ordering

  Returns this is Greater

isLe

• isLe(this): this is Less | Equal

• Test whether this Ordering is Less or Equal.

  Parameters

  • this: Ordering

  Returns this is Less | Equal

isLt

• isLt(this): this is Less

• Test whether this Ordering is Less.

  Parameters

  • this: Ordering

  Returns this is Less

isNe

• isNe(this): this is Less | Greater

• Test whether this Ordering is not Equal.

  Parameters

  • this: Ordering

  Returns this is Less | Greater

reverse

• reverse(this): Ordering

• Reverse this Ordering.

  Parameters

  • this: Ordering

  Returns Ordering

  Remarks

  • Less becomes Greater.
  • Greater becomes Less.
  • Equal remains Equal.

toNumber

• toNumber(this): 0 | 1 | -1

• Convert this Ordering to a number.

  Parameters

  • this: Ordering

  Returns 0 | 1 | -1

  Remarks

  • If this is Less, return -1.
  • If this is Greater, return 1.
  • If this is Equal, return 0.