Cypher Builder - v2.8.0
    Preparing search index...

    Interface CompositeClause

    The result of multiple clauses concatenated with Cypher.utils.concat

    interface CompositeClause {
        get children(): CypherASTNode[];
        get empty(): boolean;
        build(
            config?: Partial<
                {
                    cypherVersion: "5";
                    extraParams: Record<string, unknown>;
                    labelOperator: ":" | "&";
                    prefix: string;
                    unsafeEscapeOptions: Partial<
                        {
                            disableNodeLabelEscaping: boolean;
                            disableRelationshipTypeEscaping: boolean;
                        },
                    >;
                },
            >,
        ): CypherResult;
        concat(...clauses: (undefined | Clause)[]): this;
    }

    Hierarchy (View Summary)

    Index

    Accessors

    Methods

    Accessors

    • get children(): CypherASTNode[]

      Returns CypherASTNode[]

      Children from a composite clause should not be accessed as this will lead to unexpected behaviour

    Methods

    • Compiles a clause into Cypher and params

      Parameters

      • Optionalconfig: Partial<
            {
                cypherVersion: "5";
                extraParams: Record<string, unknown>;
                labelOperator: ":" | "&";
                prefix: string;
                unsafeEscapeOptions: Partial<
                    {
                        disableNodeLabelEscaping: boolean;
                        disableRelationshipTypeEscaping: boolean;
                    },
                >;
            },
        >

      Returns CypherResult