Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Comparator

Represents a filter comparator.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Comparator(id: number, label: string, ...aliases: string[]): Comparator

Properties

Private aliases

aliases: string[] = [] as string[]

Aliases for the command-line.

Accessors

id

  • get id(): T

  • get the index/id of this enum entry

    Returns T

index

  • get index(): T

label

  • get label(): string

  • get the label of this enum entry

    Returns string

Methods

matches

  • matches(comparator: string): boolean

  • Whether this comparator matches the given comparator string.

    Parameters

    • comparator: string

    Returns boolean

toDisplayString

  • toDisplayString(): string

  • convert this enum to a string suitable for display

    Returns string

toJSON

  • toJSON(): object

  • convert to the JSON representation

    Returns object

    • id: T
    • label: string

toString

  • toString(): T

  • convert this enum to a string

    Returns T

Generated using TypeDoc