Skip to main content

Class: FnCallWrapper

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

Wraps a function or procedure call, carrying Cypher-specific modifiers (DISTINCT, YIELD, WHERE) that plain ASTFunction does not model.

Implements

Constructors

Constructor

new FnCallWrapper(fn, distinct): FnCallWrapper

Defined in: lang-cypher/src/ast/expression.ts:18

Parameters

ParameterTypeDescription
fnASTFunctionThe underlying function or procedure being called.
distinctbooleanWhether the DISTINCT modifier eliminates duplicate argument values.

Returns

FnCallWrapper

Properties

distinct

distinct: boolean

Defined in: lang-cypher/src/ast/expression.ts:22

Whether the DISTINCT modifier eliminates duplicate argument values.


fn

fn: ASTFunction

Defined in: lang-cypher/src/ast/expression.ts:20

The underlying function or procedure being called.


procedure

procedure: boolean = false

Defined in: lang-cypher/src/ast/expression.ts:16

procedure is Cypher equivalent for table function


where

where: ASTNode

Defined in: lang-cypher/src/ast/expression.ts:14

WHERE filter applied to the rows yielded by a procedure call.


yieldItems

yieldItems: "*" | (CypherIdentifier | Aliased<CypherIdentifier>)[]

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

YIELD items projected from a procedure call, or '*' to yield all columns.

Methods

accept()

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

Defined in: lang-cypher/src/ast/expression.ts:25

Dispatches this node to the matching method on visitor.

Type Parameters

Type Parameter
Ret
Arg

Parameters

ParameterType
visitorCypherVisitor<Ret, Arg>
arg?Arg

Returns

Ret

Implementation of

ASTNode.accept