Skip to main content

Class: CypherIdentifier

Defined in: lang-cypher/src/ast/literal.ts:9

Cypher identifier that handles backtick quoting and dot-separated qualified names (e.g. `My Label` or graph.node).

Extends​

Constructors​

Constructor​

new CypherIdentifier(idOriginal): CypherIdentifier

Defined in: lang-cypher/src/ast/literal.ts:10

Parameters​

ParameterTypeDescription
idOriginalstringRaw identifier text exactly as it appeared in the source, before parsing.

Returns​

CypherIdentifier

Overrides​

ASTIdentifier.constructor

Properties​

aggregate?​

optional aggregate?: AggregateCall

Defined in: core/dist/ast.d.ts:76

Set when this identifier refers to an aggregate call in a GROUP BY context.

Inherited from​

ASTIdentifier.aggregate


idOriginal​

idOriginal: string

Defined in: lang-cypher/src/ast/literal.ts:12

Raw identifier text exactly as it appeared in the source, before parsing.


parts​

parts: (string | number | symbol)[]

Defined in: core/dist/ast.d.ts:78

Ordered sequence of name parts that form the qualified identifier.

Inherited from​

ASTIdentifier.parts

Methods​

[iterator]()​

[iterator](): ArrayIterator<string | number | symbol>

Defined in: core/dist/ast.d.ts:80

Iterates over parts in order.

Returns​

ArrayIterator<string | number | symbol>

Inherited from​

ASTIdentifier.[iterator]


accept()​

accept<Ret, Arg>(visitor, arg?): Ret

Defined in: lang-cypher/src/ast/literal.ts:19

ASTNode.accept

Type Parameters​

Type Parameter
Ret
Arg

Parameters​

ParameterType
visitorCypherVisitor<Ret, Arg>
arg?Arg

Returns​

Ret

Overrides​

ASTIdentifier.accept


equals()​

equals(other): boolean

Defined in: core/dist/ast.d.ts:86

Returns true when other has the same parts in the same order.

Parameters​

ParameterType
otherASTIdentifier

Returns​

boolean

Inherited from​

ASTIdentifier.equals


parseId()​

protected parseId(id): string

Defined in: lang-cypher/src/ast/literal.ts:24

Strips surrounding backtick delimiters from a single name part.

Parameters​

ParameterType
idstring

Returns​

string


splitId()​

protected splitId(id): string[]

Defined in: lang-cypher/src/ast/literal.ts:35

Splits a raw identifier string into individual name parts at unquoted dots, respecting backtick-quoted segments that may themselves contain dots.

Parameters​

ParameterType
idstring

Returns​

string[]


fromParts()​

static fromParts(parts): ASTIdentifier

Defined in: core/dist/ast.d.ts:84

Creates an ASTIdentifier from a pre-built parts array.

Parameters​

ParameterType
parts(string | number | symbol)[]

Returns​

ASTIdentifier

Inherited from​

ASTIdentifier.fromParts