Class Comparator

Represents a filter comparator.

Hierarchy

OnmsEnum<number>
- Comparator

Index

Constructors

Accessors

Methods

matches toDisplayString toJSON toString find

Constructors

constructor

new Comparator(id: number, label: string, ...aliases: string[]): API.Comparator
Parameters
- id: number
- label: string
- ...aliases: string[]
Returns API.Comparator
Overrides OnmsEnum<number>.constructor
- Defined in src/api/Comparator.ts:22

Accessors

id

get id(): T
get the index/id of this enum entry

Returns T
Inherited from OnmsEnum.id
- Defined in src/internal/OnmsEnum.ts:13

index

get index(): T
an alias for [[OnmsEnum.id]]

Returns T
Inherited from OnmsEnum.index
- Defined in src/internal/OnmsEnum.ts:18

label

get label(): string
get the label of this enum entry

Returns string
Inherited from OnmsEnum.label
- Defined in src/internal/OnmsEnum.ts:23

Methods

matches

matches(comparator: string): boolean
Whether this comparator matches the given comparator string.
Parameters
- comparator: string
Returns boolean
- Defined in src/api/Comparator.ts:28

toDisplayString

toDisplayString(): string
convert this enum to a string suitable for display

Returns string
Inherited from OnmsEnum.toDisplayString
- Defined in src/internal/OnmsEnum.ts:34

toJSON

toJSON(): { id: number; label: string }
convert to the JSON representation

Returns { id: number; label: string }
Inherited from OnmsEnum.toJSON
- Defined in src/internal/OnmsEnum.ts:44

toString

toString(): number
convert this enum to a string

Returns number
Inherited from OnmsEnum.toString
- Defined in src/internal/OnmsEnum.ts:39

`Static`find

find(comparator: string): API.Comparator
Find the comparator that matches the given comparator string.
Parameters
- comparator: string
Returns API.Comparator
- Defined in src/api/Comparator.ts:9