@neo4j/cypher-builder
Version:
A programmatic API for building Cypher queries for Neo4j
110 lines (109 loc) • 4.27 kB
TypeScript
import type { Expr, NormalizationType } from "../../types";
import { CypherFunction } from "./CypherFunctions";
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-btrim | Cypher Documentation}
* @group Functions
* @category String
* @since Neo4j 5.20
*/
export declare function btrim(original: string | Expr, trimCharacter?: string | Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-left | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function left(original: Expr, length: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-lower | Cypher Documentation}
* @group Functions
* @category String
* @since Neo4j 5.21
*/
export declare function lower(original: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function ltrim(original: Expr | string, trimCharacter?: string | Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
* @param normalForm - A string with the normal form to use or a Cypher expression
* @since Neo4j 5.17
* @example `Cypher.normalize(param, "NFC")`
*/
export declare function normalize(input: Expr, normalForm?: NormalizationType | Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function replace(original: Expr, search: Expr, replace: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category List
* @category String
*/
export declare function right(original: Expr, length: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function rtrim(original: Expr | string, trimCharacter?: string | Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function split(original: Expr, delimiter: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function substring(original: Expr, start: Expr, length?: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function toLower(original: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function toString(expression: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function toStringOrNull(expression: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function toUpper(original: Expr): CypherFunction;
/** @inline */
type TrimOption = "BOTH" | "LEADING" | "TRAILING";
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation}
* @group Functions
* @category String
*/
export declare function trim(type: TrimOption, trimChar: Expr, input: Expr): CypherFunction;
export declare function trim(input: Expr): CypherFunction;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-upper | Cypher Documentation}
* @group Functions
* @category String
* @since Neo4j 5.21
*/
export declare function upper(original: Expr): CypherFunction;
export {};