Class Order

Represents a sort order.

Hierarchy

OnmsEnum<string>
- Order

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Order(id: string, label: string): Order

Inherited from OnmsEnum.constructor
- Defined in internal/OnmsEnum.ts:25
construct an enum object with an id and label

Parameters
- id: string
- label: string
Returns Order

Accessors

id

get id(): T

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

Returns T

index

get index(): T

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

Returns T

label

get label(): string

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

Returns string

Methods

matches

matches(label: string): boolean

- Defined in api/OrderBy.ts:27
Whether this order matches the given order string.

Parameters
- label: string
Returns boolean

toDisplayString

toDisplayString(): string

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

Returns string

toJSON

toJSON(): object

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

Returns object
- id: T
- label: string

toString

toString(): T

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

Returns T

Static forLabel

forLabel(label: string): any

- Defined in api/OrderBy.ts:12
Given a label ('ASC', 'DESC'), return the corresponding order.

Parameters
- label: string
Returns any

Static fromString

fromString(order: string): Order | undefined

- Defined in api/OrderBy.ts:17
given an order spec (order=DESC), return an Order object

Parameters
- order: string
Returns Order | undefined

Generated using TypeDoc