@neo4j/cypher-builder
Version:
A programmatic API for building Cypher queries for Neo4j
48 lines (47 loc) • 2.11 kB
TypeScript
import type { Pattern } from "../../pattern/Pattern";
import type { Variable } from "../../references/Variable";
import type { Expr, Predicate } from "../../types";
import { CypherFunction } from "./CypherFunctions";
/** Represents a predicate function that can be used in a WHERE statement
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/ | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare class PredicateFunction extends CypherFunction {
}
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-all | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function all(variable: Variable, listExpr: Expr, whereFilter: Predicate): PredicateFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-any | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function any(variable: Variable, listExpr: Expr, whereFilter: Predicate): PredicateFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-exists | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function exists(pattern: Pattern): PredicateFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-isempty | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function isEmpty(list: Expr): PredicateFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-none | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function none(variable: Variable, listExpr: Expr, whereFilter: Predicate): PredicateFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-single | Cypher Documentation}
* @group Functions
* @category Predicate
*/
export declare function single(variable: Variable, listExpr: Expr, whereFilter: Predicate): PredicateFunction;