Class Comparator

Represents a filter comparator.

Hierarchy

OnmsEnum<number>
- Comparator

Index

Constructors

constructor

Properties

aliases

Accessors

Methods

Constructors

constructor

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

Overrides OnmsEnum.constructor
- Defined in api/Comparator.ts:20
Parameters
- id: number
- label: string
- Rest ...aliases: string[]
Returns Comparator

Properties

Private aliases

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

Aliases for the command-line.

Accessors

id

get id(): T

Inherited from OnmsEnum.id
- Defined in internal/OnmsEnum.ts:14
get the index/id of this enum entry

Returns T

index

get index(): T

Inherited from OnmsEnum.index
- Defined in internal/OnmsEnum.ts:19
an alias for OnmsEnum.id

Returns T

label

get label(): string

Inherited from OnmsEnum.label
- Defined in internal/OnmsEnum.ts:24
get the label of this enum entry

Returns string

Methods

matches

matches(comparator: string): boolean

- Defined in api/Comparator.ts:28
Whether this comparator matches the given comparator string.

Parameters
- comparator: string
Returns boolean

toDisplayString

toDisplayString(): string

Inherited from OnmsEnum.toDisplayString
- Defined in internal/OnmsEnum.ts:35
convert this enum to a string suitable for display

Returns string

toJSON

toJSON(): object

Inherited from OnmsEnum.toJSON
- Defined in internal/OnmsEnum.ts:45
convert to the JSON representation

Returns object
- id: T
- label: string

toString

toString(): T

Inherited from OnmsEnum.toString
- Defined in internal/OnmsEnum.ts:40
convert this enum to a string

Returns T

Static find

find(comparator: string): any

- Defined in api/Comparator.ts:9
Find the comparator that matches the given comparator string.

Parameters
- comparator: string
Returns any

Generated using TypeDoc