About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface IComparer<T>

Defines a method that a type implements to compare two objects.

interface IComparer<T> {
    constructor: any;
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    Compare(x: T | JsType<T>, y: T | JsType<T>): number;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
}

Type Parameters

T

Hierarchy (view full)

IInterfaceBase
- IComparer

Index

Constructors

Methods

Cast Compare TryCast

Constructors

constructor

constructor

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IInterfaceBase.Cast

Compare

Compare(x, y): number
Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
Parameters
- x: T | JsType<T>
  The first object to compare.
- y: T | JsType<T>
  The second object to compare.
Returns number
A signed integer that indicates the relative values of x and y, as shown in the following table. Value

Meaning

Less than zero

x is less than y.

Zero

x equals y.

Greater than zero

x is greater than y.

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IInterfaceBase.TryCast