Class Equal

An Ordering that indicates an "equal" comparison result.

Hierarchy

Ordering.Syntax
- Equal

Index

Properties

Methods

[cmb] [cmp] [eq] isEq isGe isGt isLe isLt isNe reverse toNumber

Properties

`Readonly` kind

kind: EQUAL = Kind.EQUAL

The property that discriminates Ordering.

`Static` `Readonly` singleton

singleton: Equal = ...

The singleton instance of Equal.

Remarks

The equal constant is a more accessible alias for this object.

Methods

[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
Inherited from Syntax.[cmb]
- Defined in cmp.ts:892

[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.
Inherited from Syntax.[cmp]
- Defined in cmp.ts:884

[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.
Inherited from Syntax.[eq]
- Defined in cmp.ts:872

isEq

isEq(this): this is Equal
Test whether this Ordering is Equal.
Parameters
- this: Ordering
Returns this is Equal
Inherited from Syntax.isEq
- Defined in cmp.ts:897

isGe

isGe(this): this is Equal | Greater
Test whether this Ordering is Greater or Equal.
Parameters
- this: Ordering
Returns this is Equal | Greater
Inherited from Syntax.isGe
- Defined in cmp.ts:922

isGt

isGt(this): this is Greater
Test whether this Ordering is Greater.
Parameters
- this: Ordering
Returns this is Greater
Inherited from Syntax.isGt
- Defined in cmp.ts:912

isLe

isLe(this): this is Less | Equal
Test whether this Ordering is Less or Equal.
Parameters
- this: Ordering
Returns this is Less | Equal
Inherited from Syntax.isLe
- Defined in cmp.ts:917

isLt

isLt(this): this is Less
Test whether this Ordering is Less.
Parameters
- this: Ordering
Returns this is Less
Inherited from Syntax.isLt
- Defined in cmp.ts:907

isNe

isNe(this): this is Less | Greater
Test whether this Ordering is not Equal.
Parameters
- this: Ordering
Returns this is Less | Greater
Inherited from Syntax.isNe
- Defined in cmp.ts:902

reverse

reverse(this): Ordering
Reverse this Ordering.
Parameters
- this: Ordering
Returns Ordering
Remarks
- Less becomes Greater.
- Greater becomes Less.
- Equal remains Equal.
Inherited from Syntax.reverse
- Defined in cmp.ts:935

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.
Inherited from Syntax.toNumber
- Defined in cmp.ts:954

Generated using TypeDoc