Skip to main content
Version: 0.3.0

OrderByPart

age-schema-client v0.3.0


age-schema-client / OrderByPart

Class: OrderByPart

Defined in: src/query/parts.ts:235

ORDER BY query part

Extends

Constructors

Constructor

new OrderByPart(items): OrderByPart;

Defined in: src/query/parts.ts:254

Create a new ORDER BY part

Parameters

ParameterTypeDefault valueDescription
itemsobject[][]Order by items

Returns

OrderByPart

Overrides

BaseQueryPart.constructor

Properties

PropertyTypeDefault valueDescriptionOverridesDefined in
typeQueryPartTypeQueryPartType.ORDER_BYQuery part typeBaseQueryPart.typesrc/query/parts.ts:239

Methods

getParameters()

getParameters(): Record<string, any>;

Defined in: src/query/parts.ts:35

Get parameters used in this query part

Returns

Record<string, any>

Inherited from

BaseQueryPart.getParameters


addItem()

addItem(expression, direction): void;

Defined in: src/query/parts.ts:268

Add an order by item

Parameters

ParameterTypeDefault valueDescription
expressionstringundefinedExpression
directionOrderDirectionOrderDirection.ASCOrder direction

Returns

void


toCypher()

toCypher(): string;

Defined in: src/query/parts.ts:275

Convert to Cypher string

Returns

string

Overrides

BaseQueryPart.toCypher